Class RAMFMessage<Payload>Abstract

constructor

• new RAMFMessage<Payload>(recipient, senderCertificate, payloadSerialized, options?): RAMFMessage<Payload>

• Type Parameters

  • Payload extends Payload

  Parameters

  • recipient: Recipient

  • senderCertificate: Certificate

  • payloadSerialized: Buffer

  • options: Partial<MessageOptions> = {}

  Returns RAMFMessage<Payload>

Readonly creationDate

Readonly id

Readonly payloadSerialized

Readonly recipient

Readonly senderCaCertificateChain

Readonly senderCertificate

Readonly ttl

expiryDate

• get expiryDate(): Date

• Returns Date

getSenderCertificationPath

• getSenderCertificationPath(trustedCertificates): Promise<readonly Certificate[]>

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

  Parameters

  • trustedCertificates: readonly Certificate[]

  Returns Promise<readonly Certificate[]>

Abstract serialize

• serialize(senderPrivateKey, signatureOptions?): Promise<ArrayBuffer>

• Return RAMF serialization of message.

  Parameters

  • senderPrivateKey: CryptoKey

  • Optional signatureOptions: Partial<SignatureOptions>

  Returns Promise<ArrayBuffer>

unwrapPayload

• unwrapPayload(privateKeyOrStore): Promise<PayloadUnwrapping<Payload>>

• Parameters

  • privateKeyOrStore: CryptoKey | PrivateKeyStore

  Returns Promise<PayloadUnwrapping<Payload>>

validate

• validate(): Promise<null>

• Report whether the message is valid.

  This doesn't check whether the sender is authorised.

  Returns Promise<null>
• validate(trustedCertificates): Promise<readonly Certificate[]>

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

  Parameters

  • trustedCertificates: readonly Certificate[]

  Returns Promise<readonly Certificate[]>

  The certification path from the sender to one of the trustedCertificates