From da22228aebee3a3ace8b71b3e3fb321876dcbf65 Mon Sep 17 00:00:00 2001 From: "kodiakhq[bot]" Date: Sat, 25 Nov 2023 23:29:16 +0000 Subject: [PATCH] deploy: af8f1d5a8742cd05a0c29e3286e9f36b60bf6d42 --- classes/CMSError.html | 4 ++-- classes/Cargo.html | 12 ++++++------ classes/CargoCollectionAuthorization.html | 12 ++++++------ classes/CargoCollectionRequest.html | 4 ++-- classes/CargoMessageSet.html | 8 ++++---- classes/Certificate.html | 16 ++++++++-------- classes/CertificateError.html | 4 ++-- classes/CertificateRotation.html | 4 ++-- classes/CertificateStore.html | 6 +++--- classes/CertificationPath.html | 4 ++-- classes/Channel.html | 6 +++--- classes/Endpoint.html | 12 ++++++------ classes/EndpointManager.html | 8 ++++---- classes/EnvelopedData.html | 10 +++++----- classes/Gateway.html | 10 +++++----- classes/GatewayChannel.html | 6 +++--- classes/GatewayManager.html | 8 ++++---- classes/HandshakeChallenge.html | 4 ++-- classes/HandshakeResponse.html | 4 ++-- classes/InternetAddressingError.html | 4 ++-- classes/InvalidMessageError.html | 4 ++-- classes/InvalidNodeConnectionParams.html | 4 ++-- classes/KeyStoreError.html | 4 ++-- classes/MockCertificateStore.html | 6 +++--- classes/MockKeyStoreSet.html | 4 ++-- classes/MockPrivateKeyStore.html | 10 +++++----- classes/MockPublicKeyStore.html | 4 ++-- classes/NodeConnectionParams.html | 4 ++-- classes/NodeError.html | 4 ++-- classes/Parcel.html | 12 ++++++------ classes/ParcelCollection.html | 4 ++-- classes/ParcelCollectionAck.html | 4 ++-- classes/ParcelCollectionHandshakeSigner.html | 6 +++--- classes/ParcelCollectionHandshakeVerifier.html | 6 +++--- classes/ParcelDelivery.html | 4 ++-- classes/ParcelDeliverySigner.html | 6 +++--- classes/ParcelDeliveryVerifier.html | 6 +++--- classes/PrivateEndpointConnParams.html | 4 ++-- classes/PrivateGateway.html | 14 +++++++------- classes/PrivateGatewayManager.html | 8 ++++---- classes/PrivateInternetGatewayChannel.html | 14 +++++++------- classes/PrivateKey.html | 4 ++-- classes/PrivateKeyStore.html | 10 +++++----- classes/PrivateNodeRegistration.html | 4 ++-- .../PrivateNodeRegistrationAuthorization.html | 4 ++-- classes/PrivateNodeRegistrationRequest.html | 4 ++-- classes/PublicKeyStore.html | 4 ++-- classes/RAMFError.html | 4 ++-- classes/RAMFMessage.html | 12 ++++++------ classes/RAMFSyntaxError.html | 4 ++-- classes/RAMFValidationError.html | 4 ++-- classes/RelaynetError.html | 4 ++-- classes/RsaPssPrivateKey.html | 4 ++-- classes/ServiceMessage.html | 8 ++++---- classes/SessionEnvelopedData.html | 14 +++++++------- classes/SessionKeyPair.html | 6 +++--- classes/SessionlessEnvelopedData.html | 12 ++++++------ classes/UnknownKeyError.html | 4 ++-- classes/UnreachableResolverError.html | 4 ++-- enums/BindingType.html | 4 ++-- enums/StreamingMode.html | 4 ++-- functions/derDeserializeECDHPrivateKey.html | 2 +- functions/derDeserializeECDHPublicKey.html | 2 +- functions/derDeserializeRSAPrivateKey.html | 2 +- functions/derDeserializeRSAPublicKey.html | 2 +- functions/derSerializePrivateKey.html | 2 +- functions/derSerializePublicKey.html | 2 +- functions/generateECDHKeyPair.html | 2 +- functions/generateRSAKeyPair.html | 2 +- functions/getIdFromIdentityKey.html | 2 +- functions/getPublicKeyDigest.html | 2 +- functions/getPublicKeyDigestHex.html | 2 +- functions/getRSAPublicKeyFromPrivate.html | 2 +- functions/issueDeliveryAuthorization.html | 2 +- functions/issueEndpointCertificate.html | 2 +- functions/issueGatewayCertificate.html | 2 +- functions/resolveInternetAddress.html | 2 +- interfaces/CargoDeliveryRequest.html | 4 ++-- interfaces/CargoRelayClient.html | 8 ++++---- .../DeliveryAuthorizationIssuanceOptions.html | 4 ++-- interfaces/EncryptionOptions.html | 4 ++-- .../EndpointCertificateIssuanceOptions.html | 4 ++-- interfaces/GSCClient.html | 4 ++-- .../GatewayCertificateIssuanceOptions.html | 4 ++-- interfaces/IdentityKeyPair.html | 4 ++-- interfaces/KeyStoreSet.html | 4 ++-- interfaces/NodeCryptoOptions.html | 4 ++-- interfaces/Payload.html | 4 ++-- interfaces/PublicNodeAddress.html | 4 ++-- interfaces/RSAKeyGenOptions.html | 4 ++-- interfaces/Recipient.html | 4 ++-- interfaces/SessionEncryptionResult.html | 8 ++++---- interfaces/SessionKey.html | 4 ++-- interfaces/SessionPrivateKeyData.html | 4 ++-- interfaces/SessionPublicKeyData.html | 4 ++-- interfaces/SignatureOptions.html | 4 ++-- types/CargoMessageSetItem.html | 2 +- types/CargoMessageStream.html | 2 +- types/ECDHCurveName.html | 2 +- types/LocalCargoId.html | 2 +- variables/MAX_RAMF_MESSAGE_LENGTH.html | 2 +- variables/MAX_SDU_PLAINTEXT_LENGTH.html | 2 +- 102 files changed, 262 insertions(+), 262 deletions(-) diff --git a/classes/CMSError.html b/classes/CMSError.html index 6b3c02a47..273b7a431 100644 --- a/classes/CMSError.html +++ b/classes/CMSError.html @@ -1,5 +1,5 @@ CMSError | @relaycorp/relaynet-core

Class CMSError

Error while processing CMS value.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

cause message stack? @@ -17,5 +17,5 @@ info

Constructors

constructor

  • Parameters

    • options: Error | Options
    • message: string
    • Rest ...params: any[]

    Returns CMSError

  • Parameters

    • Optional message: string
    • Rest ...params: any[]

    Returns CMSError

Properties

cause

cause: (() => undefined | Error)

Type declaration

    • (): undefined | Error

    • Returns undefined | Error

message

message: string

Optional stack

stack?: string

Static VError

VError: typeof VError

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

name

Methods

Static captureStackTrace

  • Create .stack property on a target object

    +

Static stackTraceLimit

stackTraceLimit: number

Accessors

name

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static cause

  • Parameters

    • err: Error

    Returns null | Error

Static errorForEach

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns void

Static errorFromList

  • Type Parameters

    • T extends Error

    Parameters

    • errors: T[]

    Returns null | T | MultiError

Static findCauseByName

  • Parameters

    • err: Error
    • name: string

    Returns null | Error

Static fullStack

  • Parameters

    • err: Error

    Returns string

Static hasCauseWithName

  • Parameters

    • err: Error
    • name: string

    Returns boolean

Static info

  • Parameters

    • err: Error

    Returns Info

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class Cargo

Relaynet Abstract Message Format, version 1.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

creationDate id payloadSerialized @@ -13,12 +13,12 @@ unwrapPayload validate deserialize -

Constructors

constructor

Properties

Readonly creationDate

creationDate: Date

Readonly id

id: string

Readonly payloadSerialized

payloadSerialized: Buffer

Readonly recipient

recipient: Recipient

Readonly senderCaCertificateChain

senderCaCertificateChain: readonly Certificate[]

Readonly senderCertificate

senderCertificate: Certificate

Readonly ttl

ttl: number

Accessors

expiryDate

Methods

getSenderCertificationPath

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

Constructors

constructor

Properties

Readonly creationDate

creationDate: Date

Readonly id

id: string

Readonly payloadSerialized

payloadSerialized: Buffer

Readonly recipient

recipient: Recipient

Readonly senderCaCertificateChain

senderCaCertificateChain: readonly Certificate[]

Readonly senderCertificate

senderCertificate: Certificate

Readonly ttl

ttl: number

Accessors

expiryDate

Methods

getSenderCertificationPath

serialize

unwrapPayload

validate

serialize

unwrapPayload

validate

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CargoCollectionAuthorization

Relaynet Abstract Message Format, version 1.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

creationDate id payloadSerialized @@ -13,12 +13,12 @@ unwrapPayload validate deserialize -

Constructors

constructor

Properties

Readonly creationDate

creationDate: Date

Readonly id

id: string

Readonly payloadSerialized

payloadSerialized: Buffer

Readonly recipient

recipient: Recipient

Readonly senderCaCertificateChain

senderCaCertificateChain: readonly Certificate[]

Readonly senderCertificate

senderCertificate: Certificate

Readonly ttl

ttl: number

Accessors

expiryDate

Methods

getSenderCertificationPath

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

Constructors

constructor

Properties

Readonly creationDate

creationDate: Date

Readonly id

id: string

Readonly payloadSerialized

payloadSerialized: Buffer

Readonly recipient

recipient: Recipient

Readonly senderCaCertificateChain

senderCaCertificateChain: readonly Certificate[]

Readonly senderCertificate

senderCertificate: Certificate

Readonly ttl

ttl: number

Accessors

expiryDate

Methods

getSenderCertificationPath

serialize

unwrapPayload

validate

serialize

unwrapPayload

validate

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CargoCollectionRequest

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.

-

Hierarchy

  • CargoCollectionRequest

Implements

Constructors

constructor +

Hierarchy

  • CargoCollectionRequest

Implements

Constructors

constructor

Properties

cargoDeliveryAuthorization

Methods

serialize deserialize -

Constructors

constructor

Properties

Readonly cargoDeliveryAuthorization

cargoDeliveryAuthorization: Certificate

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly cargoDeliveryAuthorization

cargoDeliveryAuthorization: Certificate

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CargoMessageSet.html b/classes/CargoMessageSet.html index 89fd3d126..9f14b0baf 100644 --- a/classes/CargoMessageSet.html +++ b/classes/CargoMessageSet.html @@ -1,16 +1,16 @@ CargoMessageSet | @relaycorp/relaynet-core

Class CargoMessageSet

Plaintext representation of the payload in a cargo message.

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

-

Hierarchy

  • CargoMessageSet

Implements

Constructors

constructor +

Hierarchy

  • CargoMessageSet

Implements

Constructors

constructor

Properties

messages MAX_MESSAGE_LENGTH

Methods

serialize batchMessagesSerialized deserialize deserializeItem -

Constructors

constructor

Properties

Readonly messages

messages: readonly ArrayBuffer[]

Static Readonly MAX_MESSAGE_LENGTH

MAX_MESSAGE_LENGTH: number = ...

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

+

Constructors

constructor

Properties

Readonly messages

messages: readonly ArrayBuffer[]

Static Readonly MAX_MESSAGE_LENGTH

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

serialize

Static batchMessagesSerialized

  • Parameters

    • messagesWithExpiryDate: AsyncIterable<MessageWithExpiryDate>

    Returns AsyncIterable<MessageWithExpiryDate>

Static deserialize

Static deserializeItem

Methods

serialize

Static batchMessagesSerialized

  • Parameters

    • messagesWithExpiryDate: AsyncIterable<MessageWithExpiryDate>

    Returns AsyncIterable<MessageWithExpiryDate>

Static deserialize

Static deserializeItem

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class Certificate

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.

-

Hierarchy

  • Certificate

Accessors

expiryDate +

Hierarchy

  • Certificate

Accessors

expiryDate startDate

Methods

calculateSubjectId getCertificationPath @@ -15,18 +15,18 @@ validate deserialize issue -

Accessors

expiryDate

startDate

Methods

calculateSubjectId

getCertificationPath

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

    +

Accessors

expiryDate

startDate

Methods

calculateSubjectId

getCertificationPath

  • 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

    -

getCommonName

getIssuerId

getPublicKey

getSerialNumber

getCommonName

getIssuerId

getPublicKey

getSerialNumber

  • 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

getSerialNumberHex

isEqual

serialize

validate

Static deserialize

getSerialNumberHex

isEqual

serialize

validate

Static deserialize

Static issue

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Certificate

Static issue

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CertificateError

Hierarchy

Constructors

constructor +CertificateError | @relaycorp/relaynet-core

Class CertificateError

Hierarchy

Constructors

constructor

Properties

cause message stack? @@ -16,5 +16,5 @@ info

Constructors

constructor

Properties

cause

cause: (() => undefined | Error)

Type declaration

    • (): undefined | Error

    • Returns undefined | Error

message

message: string

Optional stack

stack?: string

Static VError

VError: typeof VError

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

name

Methods

Static captureStackTrace

  • Create .stack property on a target object

    +

Static stackTraceLimit

stackTraceLimit: number

Accessors

name

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static cause

  • Parameters

    • err: Error

    Returns null | Error

Static errorForEach

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns void

Static errorFromList

  • Type Parameters

    • T extends Error

    Parameters

    • errors: T[]

    Returns null | T | MultiError

Static findCauseByName

  • Parameters

    • err: Error
    • name: string

    Returns null | Error

Static fullStack

  • Parameters

    • err: Error

    Returns string

Static hasCauseWithName

  • Parameters

    • err: Error
    • name: string

    Returns boolean

Static info

  • Parameters

    • err: Error

    Returns Info

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CertificateRotation

Hierarchy

  • CertificateRotation

Constructors

constructor +CertificateRotation | @relaycorp/relaynet-core

Class CertificateRotation

Hierarchy

  • CertificateRotation

Constructors

constructor

Properties

certificationPath

Methods

serialize deserialize -

Constructors

constructor

Properties

Readonly certificationPath

certificationPath: CertificationPath

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly certificationPath

certificationPath: CertificationPath

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CertificateStoreAbstract

Store of certificates.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Methods

deleteExpired retrieveAll retrieveLatest save -

Constructors

constructor

Methods

Abstract deleteExpired

retrieveAll

retrieveLatest

save

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

    +

Constructors

constructor

Methods

Abstract deleteExpired

retrieveAll

retrieveLatest

save

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class CertificationPath

Hierarchy

  • CertificationPath

Constructors

constructor +CertificationPath | @relaycorp/relaynet-core

Class CertificationPath

Hierarchy

  • CertificationPath

Constructors

constructor

Properties

certificateAuthorities leafCertificate

Methods

serialize deserialize -

Constructors

constructor

Properties

Readonly certificateAuthorities

certificateAuthorities: readonly Certificate[]

Readonly leafCertificate

leafCertificate: Certificate

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly certificateAuthorities

certificateAuthorities: readonly Certificate[]

Readonly leafCertificate

leafCertificate: Certificate

Methods

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Channel.html b/classes/Channel.html index 5ef5365c0..2e0cd4953 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

Constructors

constructor +Channel | @relaycorp/relaynet-core

Class Channel<Payload, PeerAddress>Abstract

Type Parameters

  • Payload extends Payload

  • PeerAddress extends PeerInternetAddress

Hierarchy

Constructors

constructor

Properties

cryptoOptions deliveryAuthPath keyStores @@ -6,7 +6,7 @@ peer

Methods

getOutboundRAMFRecipient makeMessage -

Constructors

constructor

Properties

cryptoOptions

cryptoOptions: Partial<NodeCryptoOptions> = {}

Readonly deliveryAuthPath

deliveryAuthPath: CertificationPath

Readonly keyStores

keyStores: KeyStoreSet

Readonly node

node: Node<Payload, PeerAddress>

Readonly peer

peer: Peer<PeerAddress>

Methods

getOutboundRAMFRecipient

makeMessage

  • Generate and serialise a message with the given payload.

    +

Constructors

constructor

Properties

cryptoOptions

cryptoOptions: Partial<NodeCryptoOptions> = {}

Readonly deliveryAuthPath

deliveryAuthPath: CertificationPath

Readonly keyStores

keyStores: KeyStoreSet

Readonly node

node: Node<Payload, PeerAddress>

Readonly peer

peer: Peer<PeerAddress>

Methods

getOutboundRAMFRecipient

makeMessage

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

    • Returns Promise<ArrayBuffer>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Endpoint.html b/classes/Endpoint.html index da5e2d4bc..7f5c6b84a 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

    constructor

    Properties

    cryptoOptions id identityKeyPair @@ -9,13 +9,13 @@ savePrivateEndpointChannel unwrapMessagePayload validateMessage -

    Constructors

    constructor

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    • Generate and store a new session key.

      +

    Constructors

    constructor

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    • Generate and store a new session key.

      Parameters

      • Optional peerId: string

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

        -

      Returns Promise<SessionKey>

    getChannel

    getGSCSigner

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

    savePrivateEndpointChannel

    unwrapMessagePayload

    • Decrypt and return the payload in the message.

      +

    Returns Promise<SessionKey>

    getChannel

    getGSCSigner

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

    savePrivateEndpointChannel

    unwrapMessagePayload

    • Decrypt and return the payload in the message.

      Also store the session key from the sender.

      -

      Type Parameters

      Parameters

      Returns Promise<P>

    validateMessage

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

      +

      Type Parameters

      Parameters

      Returns Promise<P>

    validateMessage

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

      Parameters

      Returns Promise<void>

      Throws

      If the message is invalid

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/EndpointManager.html b/classes/EndpointManager.html index 1952e0888..8540e52ef 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

    constructor

    Properties

    keyStores

    Methods

    get -

    Constructors

    constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/EnvelopedData.html b/classes/EnvelopedData.html index 66d0f1fb3..00be74f88 100644 --- a/classes/EnvelopedData.html +++ b/classes/EnvelopedData.html @@ -1,18 +1,18 @@ -EnvelopedData | @relaycorp/relaynet-core

    Class EnvelopedDataAbstract

    Hierarchy

    Methods

    decrypt +EnvelopedData | @relaycorp/relaynet-core

    Class EnvelopedDataAbstract

    Hierarchy

    Methods

    decrypt getRecipientKeyId serialize deserialize

    Methods

    decrypt

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

    Abstract getRecipientKeyId

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

      +

    Returns Promise<ArrayBuffer>

    Abstract getRecipientKeyId

    • 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

    serialize

    serialize

    • Return the DER serialization of the current EnvelopedData value.

      It'll be wrapped around a ContentInfo value.

      -

      Returns ArrayBuffer

    Static deserialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns EnvelopedData

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Gateway.html b/classes/Gateway.html index 760ffd76a..3e765caab 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

    Constructors

    constructor +Gateway | @relaycorp/relaynet-core

    Class Gateway<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    • Type Parameters

      • PeerAddress extends PeerInternetAddress

      Parameters

      Returns Gateway<PeerAddress>

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    • Generate and store a new session key.

      Parameters

      • Optional peerId: string

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

        -

      Returns Promise<SessionKey>

    getChannel

    • Parameters

      • peerId: string
      • peerInternetAddress: PeerAddress

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

    getGSCSigner

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

    getGSCVerifier

    • Type Parameters

      • V extends Verifier<V>

      Parameters

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

          • Parameters

            Returns V

      Returns Promise<V>

    unwrapMessagePayload

    • Decrypt and return the payload in the message.

      +

    Returns Promise<SessionKey>

    getChannel

    • Parameters

      • peerId: string
      • peerInternetAddress: PeerAddress

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

    getGSCSigner

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

    getGSCVerifier

    • Type Parameters

      • V extends Verifier<V>

      Parameters

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

          • Parameters

            Returns V

      Returns Promise<V>

    unwrapMessagePayload

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

    validateMessage

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

      +

      Type Parameters

      • P extends GatewayPayload

      Parameters

      Returns Promise<P>

    validateMessage

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/GatewayChannel.html b/classes/GatewayChannel.html index d5a501ce4..3f48054c7 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

    • Channel<GatewayPayload, PeerAddress>
      • GatewayChannel

    Constructors

    constructor +

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy

    • Channel<GatewayPayload, PeerAddress>
      • GatewayChannel

    Constructors

    constructor

    Properties

    cryptoOptions deliveryAuthPath keyStores @@ -8,7 +8,7 @@

    Methods

    generateCargoes getOutboundRAMFRecipient makeMessage -

    Constructors

    constructor

    Properties

    cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions> = {}

    Readonly deliveryAuthPath

    deliveryAuthPath: CertificationPath

    Readonly keyStores

    keyStores: KeyStoreSet

    Readonly node

    node: Node<GatewayPayload, PeerAddress>

    Readonly peer

    peer: Peer<PeerAddress>

    Methods

    generateCargoes

    getOutboundRAMFRecipient

    makeMessage

    • Generate and serialise a message with the given payload.

      +

    Constructors

    constructor

    Properties

    cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions> = {}

    Readonly deliveryAuthPath

    deliveryAuthPath: CertificationPath

    Readonly keyStores

    keyStores: KeyStoreSet

    Readonly node

    node: Node<GatewayPayload, PeerAddress>

    Readonly peer

    peer: Peer<PeerAddress>

    Methods

    generateCargoes

    getOutboundRAMFRecipient

    makeMessage

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    • Returns Promise<ArrayBuffer>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/GatewayManager.html b/classes/GatewayManager.html index 8103619a7..cf2f4ee3e 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

    Constructors

    constructor +GatewayManager | @relaycorp/relaynet-core

    Class GatewayManager<PeerAddress>Abstract

    Type Parameters

    • PeerAddress extends PeerInternetAddress

    Hierarchy

    Constructors

    constructor

    Properties

    keyStores

    Methods

    get

    Constructors

    constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    • Get node by id.

      -

      Parameters

      • id: string

      Returns Promise<null | Node<GatewayPayload, PeerAddress>>

    • Get node by id but return instance of custom customNodeClass.

      -

      Type Parameters

      • N extends Node<GatewayPayload, PeerAddress, N>

      Parameters

      • id: string
      • customNodeClass: NodeConstructor<GatewayPayload, PeerAddress>

      Returns Promise<null | N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +>.constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    • Get node by id.

      +

      Parameters

      • id: string

      Returns Promise<null | Node<GatewayPayload, PeerAddress>>

    • Get node by id but return instance of custom customNodeClass.

      +

      Type Parameters

      • N extends Node<GatewayPayload, PeerAddress, N>

      Parameters

      • id: string
      • customNodeClass: NodeConstructor<GatewayPayload, PeerAddress>

      Returns Promise<null | N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class HandshakeChallenge

    Hierarchy

    • HandshakeChallenge

    Constructors

    constructor +HandshakeChallenge | @relaycorp/relaynet-core

    Class HandshakeChallenge

    Hierarchy

    • HandshakeChallenge

    Constructors

    constructor

    Properties

    nonce

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    nonce

    nonce: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    nonce

    nonce: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class HandshakeResponse

    Hierarchy

    • HandshakeResponse

    Constructors

    constructor +HandshakeResponse | @relaycorp/relaynet-core

    Class HandshakeResponse

    Hierarchy

    • HandshakeResponse

    Constructors

    constructor

    Properties

    nonceSignatures

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    nonceSignatures

    nonceSignatures: readonly ArrayBuffer[]

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    nonceSignatures

    nonceSignatures: readonly ArrayBuffer[]

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class InternetAddressingError

    Hierarchy

    Constructors

    constructor +InternetAddressingError | @relaycorp/relaynet-core

    Class InternetAddressingError

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -16,5 +16,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class InvalidMessageError

    Error while processing message.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class InvalidNodeConnectionParams

    Hierarchy

    Constructors

    constructor +InvalidNodeConnectionParams | @relaycorp/relaynet-core

    Class InvalidNodeConnectionParams

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -16,5 +16,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/KeyStoreError.html b/classes/KeyStoreError.html index 9c2c81f30..2da421f15 100644 --- a/classes/KeyStoreError.html +++ b/classes/KeyStoreError.html @@ -1,5 +1,5 @@ KeyStoreError | @relaycorp/relaynet-core

    Class KeyStoreError

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

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class MockCertificateStore

    Store of certificates.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    dataBySubjectId

    Methods

    clear deleteExpired @@ -7,9 +7,9 @@ retrieveAll retrieveLatest save -

    Constructors

    constructor

    Properties

    dataBySubjectId

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

    Type declaration

    • [nodeId: string]: MockStoredCertificateData[]

    Methods

    clear

    deleteExpired

    forceSave

    retrieveAll

    retrieveLatest

    save

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

      +

    Constructors

    constructor

    Properties

    dataBySubjectId

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

    Type declaration

    • [nodeId: string]: MockStoredCertificateData[]

    Methods

    clear

    deleteExpired

    forceSave

    retrieveAll

    retrieveLatest

    save

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class MockKeyStoreSet

    Hierarchy

    • MockKeyStoreSet

    Implements

    Constructors

    constructor +MockKeyStoreSet | @relaycorp/relaynet-core

    Class MockKeyStoreSet

    Hierarchy

    • MockKeyStoreSet

    Implements

    Constructors

    constructor

    Properties

    certificateStore privateKeyStore publicKeyStore

    Methods

    clear -

    Constructors

    constructor

    Properties

    Readonly certificateStore

    certificateStore: MockCertificateStore = ...

    Readonly privateKeyStore

    privateKeyStore: MockPrivateKeyStore = ...

    Readonly publicKeyStore

    publicKeyStore: MockPublicKeyStore = ...

    Methods

    clear

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly certificateStore

    certificateStore: MockCertificateStore = ...

    Readonly privateKeyStore

    privateKeyStore: MockPrivateKeyStore = ...

    Readonly publicKeyStore

    publicKeyStore: MockPublicKeyStore = ...

    Methods

    clear

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class MockPrivateKeyStore

    Hierarchy

    Constructors

    constructor +MockPrivateKeyStore | @relaycorp/relaynet-core

    Class MockPrivateKeyStore

    Hierarchy

    Constructors

    constructor

    Properties

    identityKeys sessionKeys

    Methods

    clear @@ -8,18 +8,18 @@ retrieveUnboundSessionKey saveIdentityKey saveSessionKey -

    Constructors

    constructor

    Properties

    identityKeys

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

    Type declaration

    • [nodeId: string]: CryptoKey

    sessionKeys

    sessionKeys: {
        [keyId: string]: SessionPrivateKeyData;
    } = {}

    Type declaration

    Methods

    clear

    generateIdentityKeyPair

    retrieveIdentityKey

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

      +

    Constructors

    constructor

    Properties

    identityKeys

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

    Type declaration

    • [nodeId: string]: CryptoKey

    sessionKeys

    sessionKeys: {
        [keyId: string]: SessionPrivateKeyData;
    } = {}

    Type declaration

    Methods

    clear

    generateIdentityKeyPair

    retrieveIdentityKey

    retrieveSessionKey

    retrieveSessionKey

    • 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

      -

    retrieveUnboundSessionKey

    retrieveUnboundSessionKey

    • 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

      -

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class MockPublicKeyStore

    Hierarchy

    Constructors

    constructor +MockPublicKeyStore | @relaycorp/relaynet-core

    Class MockPublicKeyStore

    Hierarchy

    Constructors

    constructor

    Properties

    identityKeys sessionKeys

    Methods

    clear @@ -7,4 +7,4 @@ retrieveLastSessionKey saveIdentityKey saveSessionKey -

    Constructors

    constructor

    Properties

    identityKeys

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

    Type declaration

    • [peerId: string]: Buffer

    sessionKeys

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

    Type declaration

    Methods

    clear

    registerSessionKey

    retrieveIdentityKey

    retrieveLastSessionKey

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    identityKeys

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

    Type declaration

    • [peerId: string]: Buffer

    sessionKeys

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

    Type declaration

    Methods

    clear

    registerSessionKey

    retrieveIdentityKey

    retrieveLastSessionKey

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class NodeConnectionParams

    Hierarchy

    • NodeConnectionParams

    Constructors

    constructor +NodeConnectionParams | @relaycorp/relaynet-core

    Class NodeConnectionParams

    Hierarchy

    • NodeConnectionParams

    Constructors

    constructor

    Properties

    identityKey internetAddress sessionKey

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly identityKey

    identityKey: CryptoKey

    Readonly internetAddress

    internetAddress: string

    Readonly sessionKey

    sessionKey: SessionKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly identityKey

    identityKey: CryptoKey

    Readonly internetAddress

    internetAddress: string

    Readonly sessionKey

    sessionKey: SessionKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class NodeError

    Hierarchy

    Constructors

    constructor +NodeError | @relaycorp/relaynet-core

    Class NodeError

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -16,5 +16,5 @@ info

    Constructors

    constructor

    • Parameters

      • options: Error | Options
      • message: string
      • Rest ...params: any[]

      Returns NodeError

    • Parameters

      • Optional message: string
      • Rest ...params: any[]

      Returns NodeError

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class Parcel

    Relaynet Abstract Message Format, version 1.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    creationDate id payloadSerialized @@ -13,12 +13,12 @@ unwrapPayload validate deserialize -

    Constructors

    constructor

    Properties

    Readonly creationDate

    creationDate: Date

    Readonly id

    id: string

    Readonly payloadSerialized

    payloadSerialized: Buffer

    Readonly recipient

    recipient: Recipient

    Readonly senderCaCertificateChain

    senderCaCertificateChain: readonly Certificate[]

    Readonly senderCertificate

    senderCertificate: Certificate

    Readonly ttl

    ttl: number

    Accessors

    expiryDate

    Methods

    getSenderCertificationPath

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

    Constructors

    constructor

    Properties

    Readonly creationDate

    creationDate: Date

    Readonly id

    id: string

    Readonly payloadSerialized

    payloadSerialized: Buffer

    Readonly recipient

    recipient: Recipient

    Readonly senderCaCertificateChain

    senderCaCertificateChain: readonly Certificate[]

    Readonly senderCertificate

    senderCertificate: Certificate

    Readonly ttl

    ttl: number

    Accessors

    expiryDate

    Methods

    getSenderCertificationPath

    serialize

    unwrapPayload

    validate

    serialize

    unwrapPayload

    validate

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ParcelCollection

    Hierarchy

    • ParcelCollection

    Constructors

    constructor +ParcelCollection | @relaycorp/relaynet-core

    Class ParcelCollection

    Hierarchy

    • ParcelCollection

    Constructors

    constructor

    Properties

    parcelSerialized trustedCertificates

    Methods

    ack deserializeAndValidateParcel -

    Constructors

    constructor

    Properties

    Readonly parcelSerialized

    parcelSerialized: ArrayBuffer

    Readonly trustedCertificates

    trustedCertificates: readonly Certificate[]

    Methods

    ack

    deserializeAndValidateParcel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly parcelSerialized

    parcelSerialized: ArrayBuffer

    Readonly trustedCertificates

    trustedCertificates: readonly Certificate[]

    Methods

    ack

    deserializeAndValidateParcel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ParcelCollectionAck

    Hierarchy

    • ParcelCollectionAck

    Constructors

    constructor +ParcelCollectionAck | @relaycorp/relaynet-core

    Class ParcelCollectionAck

    Hierarchy

    • ParcelCollectionAck

    Constructors

    constructor

    Properties

    parcelId recipientEndpointId senderEndpointId FORMAT_SIGNATURE

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly parcelId

    parcelId: string

    Readonly recipientEndpointId

    recipientEndpointId: string

    Readonly senderEndpointId

    senderEndpointId: string

    Static Readonly FORMAT_SIGNATURE

    FORMAT_SIGNATURE: Uint8Array = ...

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly parcelId

    parcelId: string

    Readonly recipientEndpointId

    recipientEndpointId: string

    Readonly senderEndpointId

    senderEndpointId: string

    Static Readonly FORMAT_SIGNATURE

    FORMAT_SIGNATURE: Uint8Array = ...

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollectionHandshakeSigner.html b/classes/ParcelCollectionHandshakeSigner.html index b41bbe712..4b7130cbe 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

    constructor

    Properties

    certificate oid

    Methods

    sign

    Constructors

    constructor

    Properties

    certificate

    certificate: Certificate

    The certificate of the node

    -

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ParcelCollectionHandshakeSigner

    Properties

    certificate

    certificate: Certificate

    The certificate of the node

    +

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ParcelCollectionHandshakeVerifier.html b/classes/ParcelCollectionHandshakeVerifier.html index 7f8fa84d0..51edcbbd3 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

    constructor

    Properties

    oid

    Methods

    verify -

    Constructors

    constructor

    Properties

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    verify

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

      +

    Constructors

    constructor

    Properties

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_COLLECTION_HANDSHAKE

    Methods

    verify

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ParcelDelivery

    Hierarchy

    • ParcelDelivery

    Constructors

    constructor +ParcelDelivery | @relaycorp/relaynet-core

    Class ParcelDelivery

    Hierarchy

    • ParcelDelivery

    Constructors

    constructor

    Properties

    deliveryId parcelSerialized

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    deliveryId

    deliveryId: string

    parcelSerialized

    parcelSerialized: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    deliveryId

    deliveryId: string

    parcelSerialized

    parcelSerialized: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ParcelDeliverySigner

    Hierarchy

    • Signer
      • ParcelDeliverySigner

    Constructors

    constructor +ParcelDeliverySigner | @relaycorp/relaynet-core

    Class ParcelDeliverySigner

    Hierarchy

    • Signer
      • ParcelDeliverySigner

    Constructors

    constructor

    Properties

    certificate oid

    Methods

    sign

    Constructors

    constructor

    Properties

    certificate

    certificate: Certificate

    The certificate of the node

    -

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ParcelDeliverySigner

    Properties

    certificate

    certificate: Certificate

    The certificate of the node

    +

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ParcelDeliveryVerifier

    Hierarchy

    • Verifier
      • ParcelDeliveryVerifier

    Constructors

    constructor +ParcelDeliveryVerifier | @relaycorp/relaynet-core

    Class ParcelDeliveryVerifier

    Hierarchy

    • Verifier
      • ParcelDeliveryVerifier

    Constructors

    constructor

    Properties

    oid

    Methods

    verify -

    Constructors

    constructor

    Properties

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    verify

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

      +

    Constructors

    constructor

    Properties

    Readonly oid

    oid: string = RELAYNET_OIDS.SIGNATURE.PARCEL_DELIVERY

    Methods

    verify

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateEndpointConnParams

    Hierarchy

    • PrivateEndpointConnParams

    Constructors

    constructor +PrivateEndpointConnParams | @relaycorp/relaynet-core

    Class PrivateEndpointConnParams

    Hierarchy

    • PrivateEndpointConnParams

    Constructors

    constructor

    Properties

    deliveryAuth identityKey internetGatewayAddress sessionKey?

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly deliveryAuth

    deliveryAuth: CertificationPath

    Readonly identityKey

    identityKey: CryptoKey

    Readonly internetGatewayAddress

    internetGatewayAddress: string

    Optional Readonly sessionKey

    sessionKey?: SessionKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly deliveryAuth

    deliveryAuth: CertificationPath

    Readonly identityKey

    identityKey: CryptoKey

    Readonly internetGatewayAddress

    internetGatewayAddress: string

    Optional Readonly sessionKey

    sessionKey?: SessionKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateGateway

    Hierarchy

    Constructors

    constructor +PrivateGateway | @relaycorp/relaynet-core

    Class PrivateGateway

    Hierarchy

    Constructors

    constructor

    Properties

    cryptoOptions id identityKeyPair @@ -11,16 +11,16 @@ saveInternetGatewayChannel unwrapMessagePayload validateMessage -

    Constructors

    constructor

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    • Generate and store a new session key.

      +

    Constructors

    constructor

    Properties

    Readonly cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions>

    Readonly id

    id: string

    Readonly identityKeyPair

    identityKeyPair: CryptoKeyPair

    Readonly keyStores

    keyStores: KeyStoreSet

    Methods

    generateSessionKey

    getChannel

    getGSCSigner

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

    getGSCVerifier

    • Type Parameters

      • V extends Verifier<V>

      Parameters

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

          • Parameters

            Returns V

      Returns Promise<V>

    requestInternetGatewayRegistration

    • Produce a PrivateNodeRegistrationRequest to register with a Internet gateway.

      -

      Parameters

      • authorizationSerialized: ArrayBuffer

      Returns Promise<ArrayBuffer>

    saveInternetGatewayChannel

    • Create channel with Internet gateway using registration details.

      +

    Returns Promise<SessionKey>

    getChannel

    getGSCSigner

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

    getGSCVerifier

    • Type Parameters

      • V extends Verifier<V>

      Parameters

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

          • Parameters

            Returns V

      Returns Promise<V>

    requestInternetGatewayRegistration

    • Produce a PrivateNodeRegistrationRequest to register with a Internet gateway.

      +

      Parameters

      • authorizationSerialized: ArrayBuffer

      Returns Promise<ArrayBuffer>

    saveInternetGatewayChannel

    • Create channel with Internet gateway using registration details.

      Parameters

      Returns Promise<void>

      Throws

      NodeError if the internetGatewayIdentityCertificate didn't issue deliveryAuthorization

      -

    unwrapMessagePayload

    unwrapMessagePayload

    validateMessage

    validateMessage

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateGatewayManager

    Hierarchy

    Constructors

    constructor +PrivateGatewayManager | @relaycorp/relaynet-core

    Class PrivateGatewayManager

    Hierarchy

    Constructors

    constructor

    Properties

    keyStores

    Methods

    get -

    Constructors

    constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    • Get node by id.

      -

      Parameters

      • id: string

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

    • Get node by id but return instance of custom customNodeClass.

      -

      Type Parameters

      • N extends Node<GatewayPayload, string, N>

      Parameters

      • id: string
      • customNodeClass: NodeConstructor<GatewayPayload, string>

      Returns Promise<null | N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    keyStores

    keyStores: KeyStoreSet

    Methods

    get

    • Get node by id.

      +

      Parameters

      • id: string

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

    • Get node by id but return instance of custom customNodeClass.

      +

      Type Parameters

      • N extends Node<GatewayPayload, string, N>

      Parameters

      • id: string
      • customNodeClass: NodeConstructor<GatewayPayload, string>

      Returns Promise<null | N>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateInternetGatewayChannel

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

    -

    Hierarchy

    • PrivateGatewayChannel<string>
      • PrivateInternetGatewayChannel

    Constructors

    constructor +

    Hierarchy

    • PrivateGatewayChannel<string>
      • PrivateInternetGatewayChannel

    Constructors

    constructor

    Properties

    cryptoOptions deliveryAuthPath keyStores @@ -14,13 +14,13 @@ makeMessage registerEndpoint verifyEndpointRegistrationAuthorization -

    Constructors

    constructor

    Properties

    cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions> = {}

    Readonly deliveryAuthPath

    deliveryAuthPath: CertificationPath

    Readonly keyStores

    keyStores: KeyStoreSet

    Readonly node

    node: Node<GatewayPayload, string>

    Readonly peer

    peer: Peer<string>

    Methods

    authorizeEndpointRegistration

    • Generate a PrivateNodeRegistrationAuthorization with the gatewayData and expiryDate.

      -

      Parameters

      • gatewayData: ArrayBuffer
      • expiryDate: Date

      Returns Promise<ArrayBuffer>

    generateCCA

    generateCargoes

    getCDAIssuers

    getOrCreateCDAIssuer

    getOutboundRAMFRecipient

    makeMessage

    • Generate and serialise a message with the given payload.

      +

    Constructors

    constructor

    Properties

    cryptoOptions

    cryptoOptions: Partial<NodeCryptoOptions> = {}

    Readonly deliveryAuthPath

    deliveryAuthPath: CertificationPath

    Readonly keyStores

    keyStores: KeyStoreSet

    Readonly node

    node: Node<GatewayPayload, string>

    Readonly peer

    peer: Peer<string>

    Methods

    authorizeEndpointRegistration

    • Generate a PrivateNodeRegistrationAuthorization with the gatewayData and expiryDate.

      +

      Parameters

      • gatewayData: ArrayBuffer
      • expiryDate: Date

      Returns Promise<ArrayBuffer>

    generateCCA

    generateCargoes

    getCDAIssuers

    getOrCreateCDAIssuer

    getOutboundRAMFRecipient

    makeMessage

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

    registerEndpoint

    • Return a PrivateNodeRegistration including a new certificate for endpointPublicKey.

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

    Returns Promise<ArrayBuffer>

    registerEndpoint

    • Return a PrivateNodeRegistration including a new certificate for endpointPublicKey.

      Parameters

      • endpointPublicKey: CryptoKey

      Returns Promise<ArrayBuffer>

      The serialization of the registration

      -

    verifyEndpointRegistrationAuthorization

    verifyEndpointRegistrationAuthorization

    • Parse PrivateNodeRegistrationAuthorization and return its gatewayData if valid.

      Parameters

      • authorizationSerialized: ArrayBuffer

      Returns Promise<ArrayBuffer>

      Throws

      InvalidMessageError if the authorization is malformed, invalid or expired

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateKey

    Hierarchy

    Implements

    • CryptoKeyWithProvider

    Constructors

    constructor +PrivateKey | @relaycorp/relaynet-core

    Class PrivateKey

    Hierarchy

    Implements

    • CryptoKeyWithProvider

    Constructors

    constructor

    Properties

    algorithm extractable provider @@ -6,4 +6,4 @@ usages

    Methods

    create isKeyType -

    Constructors

    constructor

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    Readonly extractable

    extractable: true = true

    Readonly provider

    provider: ProviderCrypto

    Readonly type

    type: KeyType = ...

    usages

    usages: KeyUsages

    Methods

    Static create

    • 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

    Static isKeyType

    • Parameters

      • data: any

      Returns data is KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    Readonly extractable

    extractable: true = true

    Readonly provider

    provider: ProviderCrypto

    Readonly type

    type: KeyType = ...

    usages

    usages: KeyUsages

    Methods

    Static create

    • 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

    Static isKeyType

    • Parameters

      • data: any

      Returns data is KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateKeyStoreAbstract

    Hierarchy

    Constructors

    constructor +PrivateKeyStore | @relaycorp/relaynet-core

    Class PrivateKeyStoreAbstract

    Hierarchy

    Constructors

    constructor

    Methods

    generateIdentityKeyPair retrieveIdentityKey retrieveSessionKey retrieveUnboundSessionKey saveIdentityKey saveSessionKey -

    Constructors

    constructor

    Methods

    generateIdentityKeyPair

    Abstract retrieveIdentityKey

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

      +

    Constructors

    constructor

    Methods

    generateIdentityKeyPair

    Abstract retrieveIdentityKey

    • 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

      -

    retrieveSessionKey

    retrieveSessionKey

    • 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

      -

    retrieveUnboundSessionKey

    retrieveUnboundSessionKey

    • 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

      -

    Abstract saveIdentityKey

    saveSessionKey

    • Parameters

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

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Abstract saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateNodeRegistration

    Hierarchy

    • PrivateNodeRegistration

    Constructors

    constructor +PrivateNodeRegistration | @relaycorp/relaynet-core

    Class PrivateNodeRegistration

    Hierarchy

    • PrivateNodeRegistration

    Constructors

    constructor

    Properties

    gatewayCertificate internetGatewayInternetAddress privateNodeCertificate sessionKey

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly gatewayCertificate

    gatewayCertificate: Certificate

    Readonly internetGatewayInternetAddress

    internetGatewayInternetAddress: string

    Readonly privateNodeCertificate

    privateNodeCertificate: Certificate

    Readonly sessionKey

    sessionKey: null | SessionKey = null

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly gatewayCertificate

    gatewayCertificate: Certificate

    Readonly internetGatewayInternetAddress

    internetGatewayInternetAddress: string

    Readonly privateNodeCertificate

    privateNodeCertificate: Certificate

    Readonly sessionKey

    sessionKey: null | SessionKey = null

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateNodeRegistrationAuthorization

    Hierarchy

    • PrivateNodeRegistrationAuthorization

    Constructors

    constructor +PrivateNodeRegistrationAuthorization | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationAuthorization

    Hierarchy

    • PrivateNodeRegistrationAuthorization

    Constructors

    constructor

    Properties

    expiryDate gatewayData

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly expiryDate

    expiryDate: Date

    Readonly gatewayData

    gatewayData: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly expiryDate

    expiryDate: Date

    Readonly gatewayData

    gatewayData: ArrayBuffer

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PrivateNodeRegistrationRequest

    Hierarchy

    • PrivateNodeRegistrationRequest

    Constructors

    constructor +PrivateNodeRegistrationRequest | @relaycorp/relaynet-core

    Class PrivateNodeRegistrationRequest

    Hierarchy

    • PrivateNodeRegistrationRequest

    Constructors

    constructor

    Properties

    pnraSerialized privateNodePublicKey

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly pnraSerialized

    pnraSerialized: ArrayBuffer

    Readonly privateNodePublicKey

    privateNodePublicKey: CryptoKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly pnraSerialized

    pnraSerialized: ArrayBuffer

    Readonly privateNodePublicKey

    privateNodePublicKey: CryptoKey

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class PublicKeyStoreAbstract

    Hierarchy

    Constructors

    constructor +PublicKeyStore | @relaycorp/relaynet-core

    Class PublicKeyStoreAbstract

    Hierarchy

    Constructors

    constructor

    Methods

    retrieveIdentityKey retrieveLastSessionKey saveIdentityKey saveSessionKey -

    Constructors

    constructor

    Methods

    retrieveIdentityKey

    retrieveLastSessionKey

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    retrieveIdentityKey

    retrieveLastSessionKey

    saveIdentityKey

    saveSessionKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RAMFError

    Error while processing RAMF message.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    • Parameters

      • options: Error | Options
      • message: string
      • Rest ...params: any[]

      Returns RAMFError

    • Parameters

      • Optional message: string
      • Rest ...params: any[]

      Returns RAMFError

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/RAMFMessage.html b/classes/RAMFMessage.html index 45a403b77..3eba1adeb 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

    Constructors

    constructor +

    Type Parameters

    Hierarchy

    Constructors

    constructor

    Properties

    creationDate id payloadSerialized @@ -12,12 +12,12 @@ serialize unwrapPayload validate -

    Constructors

    constructor

    Properties

    Readonly creationDate

    creationDate: Date

    Readonly id

    id: string

    Readonly payloadSerialized

    payloadSerialized: Buffer

    Readonly recipient

    recipient: Recipient

    Readonly senderCaCertificateChain

    senderCaCertificateChain: readonly Certificate[]

    Readonly senderCertificate

    senderCertificate: Certificate

    Readonly ttl

    ttl: number

    Accessors

    expiryDate

    Methods

    getSenderCertificationPath

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

    Constructors

    constructor

    Properties

    Readonly creationDate

    creationDate: Date

    Readonly id

    id: string

    Readonly payloadSerialized

    payloadSerialized: Buffer

    Readonly recipient

    recipient: Recipient

    Readonly senderCaCertificateChain

    senderCaCertificateChain: readonly Certificate[]

    Readonly senderCertificate

    senderCertificate: Certificate

    Readonly ttl

    ttl: number

    Accessors

    expiryDate

    Methods

    getSenderCertificationPath

    Abstract serialize

    • Return RAMF serialization of message.

      -

      Parameters

      Returns Promise<ArrayBuffer>

    unwrapPayload

    validate

    Abstract serialize

    • Return RAMF serialization of message.

      +

      Parameters

      Returns Promise<ArrayBuffer>

    unwrapPayload

    validate

    • 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

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RAMFSyntaxError

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

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RAMFValidationError

    Error while validating RAMF message.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RelaynetErrorAbstract

    Hierarchy

    Constructors

    constructor +RelaynetError | @relaycorp/relaynet-core

    Class RelaynetErrorAbstract

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -16,5 +16,5 @@ info

    Constructors

    constructor

    • Parameters

      • options: Error | Options
      • message: string
      • Rest ...params: any[]

      Returns RelaynetError

    • Parameters

      • Optional message: string
      • Rest ...params: any[]

      Returns RelaynetError

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class RsaPssPrivateKey

    Hierarchy

    Constructors

    constructor +RsaPssPrivateKey | @relaycorp/relaynet-core

    Class RsaPssPrivateKey

    Hierarchy

    Constructors

    constructor

    Properties

    algorithm extractable provider @@ -6,4 +6,4 @@ usages

    Methods

    create isKeyType -

    Constructors

    constructor

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    Readonly extractable

    extractable: true = true

    Readonly provider

    provider: ProviderCrypto

    Readonly type

    type: KeyType = ...

    Readonly usages

    usages: KeyUsages = ...

    Methods

    Static create

    • 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

    Static isKeyType

    • Parameters

      • data: any

      Returns data is KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    Readonly extractable

    extractable: true = true

    Readonly provider

    provider: ProviderCrypto

    Readonly type

    type: KeyType = ...

    Readonly usages

    usages: KeyUsages = ...

    Methods

    Static create

    • 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

    Static isKeyType

    • Parameters

      • data: any

      Returns data is KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ServiceMessage

    Service message as encapsulated in a parcel.

    -

    Hierarchy

    • ServiceMessage

    Implements

    Constructors

    constructor +

    Hierarchy

    • ServiceMessage

    Implements

    Constructors

    constructor

    Properties

    content type

    Methods

    serialize deserialize -

    Constructors

    constructor

    Properties

    Readonly content

    content: Buffer

    Readonly type

    type: string

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly content

    content: Buffer

    Readonly type

    type: string

    Methods

    serialize

    Static deserialize

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class SessionEnvelopedData

    CMS EnvelopedData representation using the Channel Session Protocol.

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

    -

    Hierarchy

    Methods

    decrypt +

    Hierarchy

    Methods

    decrypt getOriginatorKey getRecipientKeyId serialize @@ -8,20 +8,20 @@ encrypt

    Methods

    decrypt

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

    getOriginatorKey

    getRecipientKeyId

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

      +

    Returns Promise<ArrayBuffer>

    getOriginatorKey

    getRecipientKeyId

    • 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

    serialize

    serialize

    Static deserialize

    Static deserialize

    Static encrypt

    Static encrypt

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SessionEncryptionResult>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class SessionKeyPair

    Hierarchy

    • SessionKeyPair

    Constructors

    constructor +SessionKeyPair | @relaycorp/relaynet-core

    Class SessionKeyPair

    Hierarchy

    • SessionKeyPair

    Constructors

    constructor

    Properties

    privateKey sessionKey

    Methods

    generate -

    Constructors

    constructor

    Properties

    Readonly privateKey

    privateKey: CryptoKey

    Readonly sessionKey

    sessionKey: SessionKey

    Methods

    Static generate

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly privateKey

    privateKey: CryptoKey

    Readonly sessionKey

    sessionKey: SessionKey

    Methods

    Static generate

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class SessionlessEnvelopedData

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

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

    -

    Hierarchy

    Methods

    decrypt +

    Hierarchy

    Methods

    decrypt getRecipientKeyId serialize deserialize encrypt

    Methods

    decrypt

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

    getRecipientKeyId

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

      +

    Returns Promise<ArrayBuffer>

    getRecipientKeyId

    • 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

    serialize

    serialize

    Static deserialize

    Static deserialize

    Static encrypt

    Static encrypt

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<SessionlessEnvelopedData>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class UnknownKeyError

    Error thrown when a peer references an invalid key.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -17,5 +17,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class UnreachableResolverError

    Hierarchy

    Constructors

    constructor +UnreachableResolverError | @relaycorp/relaynet-core

    Class UnreachableResolverError

    Hierarchy

    Constructors

    constructor

    Properties

    cause message stack? @@ -16,5 +16,5 @@ info

    Constructors

    constructor

    Properties

    cause

    cause: (() => undefined | Error)

    Type declaration

      • (): undefined | Error

      • Returns undefined | Error

    message

    message: string

    Optional stack

    stack?: string

    Static VError

    VError: typeof VError

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    name

    Methods

    Static captureStackTrace

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Static cause

    • Parameters

      • err: Error

      Returns null | Error

    Static errorForEach

    • Parameters

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

          • Parameters

            • err: Error

            Returns void

      Returns void

    Static errorFromList

    • Type Parameters

      • T extends Error

      Parameters

      • errors: T[]

      Returns null | T | MultiError

    Static findCauseByName

    • Parameters

      • err: Error
      • name: string

      Returns null | Error

    Static fullStack

    • Parameters

      • err: Error

      Returns string

    Static hasCauseWithName

    • Parameters

      • err: Error
      • name: string

      Returns boolean

    Static info

    • Parameters

      • err: Error

      Returns Info

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/BindingType.html b/enums/BindingType.html index 5864bdeb5..9b6619a4e 100644 --- a/enums/BindingType.html +++ b/enums/BindingType.html @@ -1,4 +1,4 @@ -BindingType | @relaycorp/relaynet-core

    Enumeration BindingType

    Enumeration Members

    CRC +BindingType | @relaycorp/relaynet-core

    Enumeration BindingType

    Enumeration Members

    CRC GSC PDC -

    Enumeration Members

    CRC

    CRC: "awala-crc"

    GSC

    GSC: "awala-gsc"

    PDC

    PDC: "awala-pdc"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CRC

    CRC: "awala-crc"

    GSC

    GSC: "awala-gsc"

    PDC

    PDC: "awala-pdc"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/StreamingMode.html b/enums/StreamingMode.html index 3072a1de4..39e1f8ee6 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

    Enumeration StreamingMode

    Enumeration Members

    CLOSE_UPON_COMPLETION KEEP_ALIVE -

    Enumeration Members

    CLOSE_UPON_COMPLETION

    CLOSE_UPON_COMPLETION: "close-upon-completion"

    KEEP_ALIVE

    KEEP_ALIVE: "keep-alive"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    CLOSE_UPON_COMPLETION

    CLOSE_UPON_COMPLETION: "close-upon-completion"

    KEEP_ALIVE

    KEEP_ALIVE: "keep-alive"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeECDHPrivateKey.html b/functions/derDeserializeECDHPrivateKey.html index 244b1a02d..8d6ea1f71 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeECDHPublicKey.html b/functions/derDeserializeECDHPublicKey.html index bce3c2986..280db38ea 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeRSAPrivateKey.html b/functions/derDeserializeRSAPrivateKey.html index 21837be59..7e2a28553 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derDeserializeRSAPublicKey.html b/functions/derDeserializeRSAPublicKey.html index 61fdafe7b..be4603a5e 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKey>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/derSerializePrivateKey.html b/functions/derSerializePrivateKey.html index 7ef3fe478..c56575ea8 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Buffer>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function derSerializePublicKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Buffer>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function generateECDHKeyPair

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<CryptoKeyPair>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/generateRSAKeyPair.html b/functions/generateRSAKeyPair.html index 84e2be9cf..214d06120 100644 --- a/functions/generateRSAKeyPair.html +++ b/functions/generateRSAKeyPair.html @@ -1,4 +1,4 @@ generateRSAKeyPair | @relaycorp/relaynet-core

    Function generateRSAKeyPair

    • Generate an RSA-PSS key pair.

      Parameters

      Returns Promise<CryptoKeyPair>

      Throws

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getIdFromIdentityKey.html b/functions/getIdFromIdentityKey.html index 8b2c2f356..0e5188b18 100644 --- a/functions/getIdFromIdentityKey.html +++ b/functions/getIdFromIdentityKey.html @@ -1 +1 @@ -getIdFromIdentityKey | @relaycorp/relaynet-core

    Function getIdFromIdentityKey

    • Parameters

      • identityPublicKey: CryptoKey

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getIdFromIdentityKey

    • Parameters

      • identityPublicKey: CryptoKey

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getPublicKeyDigest

    • Return SHA-256 digest of public key.

      -

      Parameters

      • publicKey: CryptoKey

      Returns Promise<ArrayBuffer>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<ArrayBuffer>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/getPublicKeyDigestHex.html b/functions/getPublicKeyDigestHex.html index 212d1d7f6..9e317bad8 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getRSAPublicKeyFromPrivate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function getRSAPublicKeyFromPrivate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function issueDeliveryAuthorization

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function issueEndpointCertificate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function issueGatewayCertificate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Certificate>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/resolveInternetAddress.html b/functions/resolveInternetAddress.html index ccb39880f..993bd406d 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Interface CargoDeliveryRequest

    Request to deliver a cargo.

    -

    Hierarchy

    • CargoDeliveryRequest

    Properties

    cargo +

    Hierarchy

    • CargoDeliveryRequest

    Properties

    cargo localId -

    Properties

    Readonly cargo

    cargo: Buffer

    Readonly localId

    localId: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly cargo

    cargo: Buffer

    Readonly localId

    localId: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/CargoRelayClient.html b/interfaces/CargoRelayClient.html index 2a11511e9..d8cdc46ef 100644 --- a/interfaces/CargoRelayClient.html +++ b/interfaces/CargoRelayClient.html @@ -1,9 +1,9 @@ CargoRelayClient | @relaycorp/relaynet-core

    Interface CargoRelayClient

    Interface for cargo relay clients

    -

    Hierarchy

    • CargoRelayClient

    Properties

    close +

    Hierarchy

    • CargoRelayClient

    Properties

    close collectCargo deliverCargo

    Properties

    Readonly close

    close: (() => void)

    Type declaration

      • (): void

      • Close the underlying connection, if applicable

        -

        Returns void

    Readonly collectCargo

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

    Type declaration

      • (): readonly Buffer[]

      • Collect and return cargo

        -

        Returns readonly Buffer[]

    Readonly deliverCargo

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

    Type declaration

      • (cargo): IterableIterator<string>

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

        Returns void

    Readonly collectCargo

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

    Type declaration

      • (): readonly Buffer[]

      • Collect and return cargo

        +

        Returns readonly Buffer[]

    Readonly deliverCargo

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

    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>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns IterableIterator<string>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface DeliveryAuthorizationIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • DeliveryAuthorizationIssuanceOptions

    Properties

    issuerCertificate +DeliveryAuthorizationIssuanceOptions | @relaycorp/relaynet-core

    Interface DeliveryAuthorizationIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • DeliveryAuthorizationIssuanceOptions

    Properties

    issuerCertificate issuerPrivateKey subjectPublicKey validityEndDate validityStartDate? -

    Properties

    Readonly issuerCertificate

    issuerCertificate: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly issuerCertificate

    issuerCertificate: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/EncryptionOptions.html b/interfaces/EncryptionOptions.html index 3e4a0a86c..1b6df90db 100644 --- a/interfaces/EncryptionOptions.html +++ b/interfaces/EncryptionOptions.html @@ -1,3 +1,3 @@ -EncryptionOptions | @relaycorp/relaynet-core

    Interface EncryptionOptions

    Hierarchy

    • EncryptionOptions

    Properties

    aesKeySize +EncryptionOptions | @relaycorp/relaynet-core

    Interface EncryptionOptions

    Hierarchy

    • EncryptionOptions

    Properties

    aesKeySize

    Properties

    Readonly aesKeySize

    aesKeySize: number

    The AES key size (128, 192 or 256)

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/EndpointCertificateIssuanceOptions.html b/interfaces/EndpointCertificateIssuanceOptions.html index 1033ac5be..8125c3f38 100644 --- a/interfaces/EndpointCertificateIssuanceOptions.html +++ b/interfaces/EndpointCertificateIssuanceOptions.html @@ -1,6 +1,6 @@ -EndpointCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface EndpointCertificateIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • EndpointCertificateIssuanceOptions

    Properties

    issuerCertificate? +EndpointCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface EndpointCertificateIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • EndpointCertificateIssuanceOptions

    Properties

    issuerCertificate? issuerPrivateKey subjectPublicKey validityEndDate validityStartDate? -

    Properties

    Optional Readonly issuerCertificate

    issuerCertificate?: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly issuerCertificate

    issuerCertificate?: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/GSCClient.html b/interfaces/GSCClient.html index c6a64d791..dc3c73f66 100644 --- a/interfaces/GSCClient.html +++ b/interfaces/GSCClient.html @@ -1,5 +1,5 @@ -GSCClient | @relaycorp/relaynet-core

    Interface GSCClient

    Hierarchy

    • GSCClient

    Properties

    collectParcels +GSCClient | @relaycorp/relaynet-core

    Interface GSCClient

    Hierarchy

    • GSCClient

    Properties

    collectParcels deliverParcel preRegisterNode registerNode -

    Properties

    Readonly collectParcels

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

    Type declaration

    Readonly deliverParcel

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

    Type declaration

      • (parcelSerialized, signer): Promise<void>

      • Parameters

        Returns Promise<void>

    Readonly preRegisterNode

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

    Type declaration

      • (nodePublicKey): Promise<ArrayBuffer>

      • Parameters

        • nodePublicKey: CryptoKey

        Returns Promise<ArrayBuffer>

    Readonly registerNode

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly collectParcels

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

    Type declaration

    Readonly deliverParcel

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

    Type declaration

      • (parcelSerialized, signer): Promise<void>

      • Parameters

        Returns Promise<void>

    Readonly preRegisterNode

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

    Type declaration

      • (nodePublicKey): Promise<ArrayBuffer>

      • Parameters

        • nodePublicKey: CryptoKey

        Returns Promise<ArrayBuffer>

    Readonly registerNode

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

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface GatewayCertificateIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • GatewayCertificateIssuanceOptions

    Properties

    issuerCertificate? +GatewayCertificateIssuanceOptions | @relaycorp/relaynet-core

    Interface GatewayCertificateIssuanceOptions

    Hierarchy

    • BasicCertificateIssuanceOptions
      • GatewayCertificateIssuanceOptions

    Properties

    issuerCertificate? issuerPrivateKey subjectPublicKey validityEndDate validityStartDate? -

    Properties

    Optional Readonly issuerCertificate

    issuerCertificate?: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly issuerCertificate

    issuerCertificate?: Certificate

    Readonly issuerPrivateKey

    issuerPrivateKey: CryptoKey

    Readonly subjectPublicKey

    subjectPublicKey: CryptoKey

    Readonly validityEndDate

    validityEndDate: Date

    Optional Readonly validityStartDate

    validityStartDate?: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/IdentityKeyPair.html b/interfaces/IdentityKeyPair.html index 66f52c5b8..16031288d 100644 --- a/interfaces/IdentityKeyPair.html +++ b/interfaces/IdentityKeyPair.html @@ -1,4 +1,4 @@ -IdentityKeyPair | @relaycorp/relaynet-core

    Interface IdentityKeyPair

    Hierarchy

    • CryptoKeyPair
      • IdentityKeyPair

    Properties

    id +IdentityKeyPair | @relaycorp/relaynet-core

    Interface IdentityKeyPair

    Hierarchy

    • CryptoKeyPair
      • IdentityKeyPair

    Properties

    id privateKey publicKey -

    Properties

    Readonly id

    id: string

    privateKey

    privateKey: CryptoKey

    publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly id

    id: string

    privateKey

    privateKey: CryptoKey

    publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/KeyStoreSet.html b/interfaces/KeyStoreSet.html index adff48651..55cd321cb 100644 --- a/interfaces/KeyStoreSet.html +++ b/interfaces/KeyStoreSet.html @@ -1,4 +1,4 @@ -KeyStoreSet | @relaycorp/relaynet-core

    Interface KeyStoreSet

    Hierarchy

    • KeyStoreSet

    Implemented by

    Properties

    certificateStore +KeyStoreSet | @relaycorp/relaynet-core

    Interface KeyStoreSet

    Hierarchy

    • KeyStoreSet

    Implemented by

    Properties

    certificateStore privateKeyStore publicKeyStore -

    Properties

    Readonly certificateStore

    certificateStore: CertificateStore

    Readonly privateKeyStore

    privateKeyStore: PrivateKeyStore

    Readonly publicKeyStore

    publicKeyStore: PublicKeyStore

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly certificateStore

    certificateStore: CertificateStore

    Readonly privateKeyStore

    privateKeyStore: PrivateKeyStore

    Readonly publicKeyStore

    publicKeyStore: PublicKeyStore

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/NodeCryptoOptions.html b/interfaces/NodeCryptoOptions.html index 083df6ec0..f0e97c048 100644 --- a/interfaces/NodeCryptoOptions.html +++ b/interfaces/NodeCryptoOptions.html @@ -1,3 +1,3 @@ -NodeCryptoOptions | @relaycorp/relaynet-core

    Interface NodeCryptoOptions

    Hierarchy

    • NodeCryptoOptions

    Properties

    encryption +NodeCryptoOptions | @relaycorp/relaynet-core

    Interface NodeCryptoOptions

    Hierarchy

    • NodeCryptoOptions

    Properties

    encryption signature -

    Properties

    Readonly encryption

    encryption: Partial<EncryptionOptions>

    Readonly signature

    signature: Partial<SignatureOptions>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly encryption

    encryption: Partial<EncryptionOptions>

    Readonly signature

    signature: Partial<SignatureOptions>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Payload

    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.

    -

    Hierarchy

    • Payload

    Implemented by

    Properties

    serialize -

    Properties

    Readonly serialize

    serialize: (() => ArrayBuffer)

    Type declaration

      • (): ArrayBuffer

      • Returns ArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Implemented by

    Properties

    serialize +

    Properties

    Readonly serialize

    serialize: (() => ArrayBuffer)

    Type declaration

      • (): ArrayBuffer

      • Returns ArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/PublicNodeAddress.html b/interfaces/PublicNodeAddress.html index 28f628abc..8c18eb2d4 100644 --- a/interfaces/PublicNodeAddress.html +++ b/interfaces/PublicNodeAddress.html @@ -1,3 +1,3 @@ -PublicNodeAddress | @relaycorp/relaynet-core

    Interface PublicNodeAddress

    Hierarchy

    • PublicNodeAddress

    Properties

    host +PublicNodeAddress | @relaycorp/relaynet-core

    Interface PublicNodeAddress

    Hierarchy

    • PublicNodeAddress

    Properties

    host port -

    Properties

    Readonly host

    host: string

    Readonly port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly host

    host: string

    Readonly port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/RSAKeyGenOptions.html b/interfaces/RSAKeyGenOptions.html index 36913a132..659e8aff7 100644 --- a/interfaces/RSAKeyGenOptions.html +++ b/interfaces/RSAKeyGenOptions.html @@ -1,3 +1,3 @@ -RSAKeyGenOptions | @relaycorp/relaynet-core

    Interface RSAKeyGenOptions

    Hierarchy

    • RSAKeyGenOptions

    Properties

    hashingAlgorithm +RSAKeyGenOptions | @relaycorp/relaynet-core

    Interface RSAKeyGenOptions

    Hierarchy

    • RSAKeyGenOptions

    Properties

    hashingAlgorithm modulus -

    Properties

    Readonly hashingAlgorithm

    hashingAlgorithm: HashingAlgorithm

    Readonly modulus

    modulus: RSAModulus

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly hashingAlgorithm

    hashingAlgorithm: HashingAlgorithm

    Readonly modulus

    modulus: RSAModulus

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Recipient.html b/interfaces/Recipient.html index 69b865901..2215e9208 100644 --- a/interfaces/Recipient.html +++ b/interfaces/Recipient.html @@ -1,3 +1,3 @@ -Recipient | @relaycorp/relaynet-core

    Interface Recipient

    Hierarchy

    • Recipient

    Properties

    id +Recipient | @relaycorp/relaynet-core

    Interface Recipient

    Hierarchy

    • Recipient

    Properties

    id internetAddress? -

    Properties

    Readonly id

    id: string

    Optional Readonly internetAddress

    internetAddress?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly id

    id: string

    Optional Readonly internetAddress

    internetAddress?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionEncryptionResult.html b/interfaces/SessionEncryptionResult.html index ab4b743f5..e16571fdf 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.

    -

    Hierarchy

    • SessionEncryptionResult

    Properties

    dhKeyId +

    Hierarchy

    • SessionEncryptionResult

    Properties

    dhKeyId dhPrivateKey envelopedData

    Properties

    Readonly dhKeyId

    dhKeyId: ArrayBuffer

    Id of ECDH key pair.

    -

    Readonly dhPrivateKey

    dhPrivateKey: CryptoKey

    Private key of the ECDH key pair

    -

    Readonly envelopedData

    envelopedData: SessionEnvelopedData

    EnvelopedData value using the Channel Session Protocol.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly dhPrivateKey

    dhPrivateKey: CryptoKey

    Private key of the ECDH key pair

    +

    Readonly envelopedData

    envelopedData: SessionEnvelopedData

    EnvelopedData value using the Channel Session Protocol.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface SessionKey

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

    -

    Hierarchy

    • SessionKey

    Properties

    keyId +

    Hierarchy

    • SessionKey

    Properties

    keyId publicKey -

    Properties

    Readonly keyId

    keyId: Buffer

    Readonly publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly keyId

    keyId: Buffer

    Readonly publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SessionPrivateKeyData.html b/interfaces/SessionPrivateKeyData.html index a26148ad6..e8b30d108 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.

    -

    Hierarchy

    • SessionPrivateKeyData

    Properties

    keySerialized +

    Hierarchy

    • SessionPrivateKeyData

    Properties

    keySerialized nodeId peerId? -

    Properties

    Readonly keySerialized

    keySerialized: Buffer

    Readonly nodeId

    nodeId: string

    Optional Readonly peerId

    peerId?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly keySerialized

    keySerialized: Buffer

    Readonly nodeId

    nodeId: string

    Optional Readonly peerId

    peerId?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface SessionPublicKeyData

    Hierarchy

    • SessionPublicKeyData

    Properties

    publicKeyCreationTime +SessionPublicKeyData | @relaycorp/relaynet-core

    Interface SessionPublicKeyData

    Hierarchy

    • SessionPublicKeyData

    Properties

    publicKeyCreationTime publicKeyDer publicKeyId -

    Properties

    Readonly publicKeyCreationTime

    publicKeyCreationTime: Date

    Readonly publicKeyDer

    publicKeyDer: Buffer

    Readonly publicKeyId

    publicKeyId: Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly publicKeyCreationTime

    publicKeyCreationTime: Date

    Readonly publicKeyDer

    publicKeyDer: Buffer

    Readonly publicKeyId

    publicKeyId: Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/SignatureOptions.html b/interfaces/SignatureOptions.html index 5009dfc68..277d99df9 100644 --- a/interfaces/SignatureOptions.html +++ b/interfaces/SignatureOptions.html @@ -1,2 +1,2 @@ -SignatureOptions | @relaycorp/relaynet-core

    Interface SignatureOptions

    Hierarchy

    • SignatureOptions

    Properties

    hashingAlgorithmName -

    Properties

    Readonly hashingAlgorithmName

    hashingAlgorithmName: HashingAlgorithm

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface SignatureOptions

    Hierarchy

    • SignatureOptions

    Properties

    hashingAlgorithmName +

    Properties

    Readonly hashingAlgorithmName

    hashingAlgorithmName: HashingAlgorithm

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Type alias CargoMessageSetItem

    CargoMessageSetItem: Parcel | ParcelCollectionAck | CertificateRotation

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias CargoMessageSetItem

    CargoMessageSetItem: Parcel | ParcelCollectionAck | CertificateRotation

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CargoMessageStream.html b/types/CargoMessageStream.html index 97a00feac..0fef39109 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

    Settings

    Member Visibility

    Theme

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ECDHCurveName.html b/types/ECDHCurveName.html index 168766daa..e19146b0d 100644 --- a/types/ECDHCurveName.html +++ b/types/ECDHCurveName.html @@ -1 +1 @@ -ECDHCurveName | @relaycorp/relaynet-core

    Type alias ECDHCurveName

    ECDHCurveName: "P-256" | "P-384" | "P-521"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ECDHCurveName

    ECDHCurveName: "P-256" | "P-384" | "P-521"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/LocalCargoId.html b/types/LocalCargoId.html index 955500250..e31bac24b 100644 --- a/types/LocalCargoId.html +++ b/types/LocalCargoId.html @@ -1,3 +1,3 @@ LocalCargoId | @relaycorp/relaynet-core

    Type alias LocalCargoId

    LocalCargoId: string

    The local id of the cargo to be delivered.

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 a1394308d..cfce8c773 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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 960d127f0..e3505d3a1 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file