Class WfCoreMessage

A core Whiteflag message as defined by the Whiteflag specification WfCoreMessage

Wfversion

v1-draft.7

Wfreference

4 Message Format

Remarks

Ths class represents a core Whiteflag message as defined by the Whiteflag specification. It has a message header and a message body which contain the message fields as specified for the message type. It performs the encoding/encryption and decoding/decryption to and from binary messages. Since the processing of Whiteflag messges in accordance with the protocol requires additional metadata, the extrended WfMessage class of the @whitelag/protol package should normallly be used instead of this class.

Hierarchy (View Summary)

WfCoreMessage
- WfMessage

Index

Constructors

constructor

Methods

decode encode get isEncoded isValid set toHex toObject toString toU8a validate fromBinary fromHex fromObject fromU8a

Constructors

constructor

new WfCoreMessage(
    type: WfMsgType,
    version?: v1,
    binary?: BinaryBuffer,
): WfCoreMessage
Constructor for a Whiteflag message
Parameters
- type: WfMsgType
  the Whiteflag message type
- version: v1 = WfVersion.v1
  the Whiteflag protocol version
- Optionalbinary: BinaryBuffer
  the binary encoded message, if available at creation
Returns WfCoreMessage
- Defined in src/core/lib/message.ts:109

Methods

decode

decode(message: BinaryBuffer): Promise<WfCoreMessage>
Decodes an unencrypted binary encoded message
Parameters
- message: BinaryBuffer
  a binary encoded message
Returns Promise<WfCoreMessage>
a new Whiteflag message object
- Defined in src/core/lib/message.ts:253

encode

encode(
    ikm?: Uint8Array<ArrayBufferLike>,
    address?: Uint8Array<ArrayBufferLike>,
    iv?: Uint8Array<ArrayBufferLike>,
): Promise<WfCoreMessage>
Function
Encodes the message, making the contents final encode
Parameters
- Optionalikm: Uint8Array<ArrayBufferLike>
  the input key material to derive the encryption key, if the message is to be encrypted
- Optionaladdress: Uint8Array<ArrayBufferLike>
  the binary encoded originator address, if the message is to be encrypted
- Optionaliv: Uint8Array<ArrayBufferLike>
  the initialisation vector, if required for the encryption method
Returns Promise<WfCoreMessage>
this Whitedlag message object with the encoded message
- Defined in src/core/lib/message.ts:302

get

get(fieldName: string): string | null
Function
Returns the value of the specified message field get
Parameters
- fieldName: string
  the name of the message field
Returns string | null
the value of the message field
- Defined in src/core/lib/message.ts:346

isEncoded

isEncoded(): boolean
Function
Indicates if the message has already been encoded isEncoded

Returns boolean
true if message has been encoded, else false
- Defined in src/core/lib/message.ts:227

isValid

isValid(): boolean
Function
Indicates if the message is valid, i.e. if all fields contain valid values isValid

Returns boolean
true if message is valid, else false
- Defined in src/core/lib/message.ts:236

set

set(fieldName: string, value: string): boolean
Function
Sets the value of the specified message field, if the message has not been encoded set
Parameters
- fieldName: string
  the name of the message field
- value: string
  the value to set
Returns boolean
true if succesful, else false
- Defined in src/core/lib/message.ts:365

toHex

toHex(): string
Function
Returns the Whiteflag message encoded as a hexadecimal string toHex

Returns string
a hexadecimal string with the encoded message
- Defined in src/core/lib/message.ts:433

toObject

toObject(): Object
Function
Returns the Whiteflag message as a plain object toObject

Returns Object
the message as a plain object
- Defined in src/core/lib/message.ts:403

toString

toString(): string
Function
Returns the Whiteflag message as a string toString

Returns string
a concatinated string of field values
- Defined in src/core/lib/message.ts:414

toU8a

toU8a(): Uint8Array
Function
Returns the encoded Whiteflag message as a UInt8array toU8a

Returns Uint8Array
a UInt8array with the encoded message
- Defined in src/core/lib/message.ts:442

validate

validate(): string[]
Function
Returns message validation errors validate

Returns string[]
an array of validation errors
- Defined in src/core/lib/message.ts:245

`Static`fromBinary

fromBinary(
    message: BinaryBuffer,
    ikm?: Uint8Array<ArrayBufferLike>,
    address?: Uint8Array<ArrayBufferLike>,
    iv?: Uint8Array<ArrayBufferLike>,
): Promise<WfCoreMessage>
Function
Creates new Whiteflag message from a binary buffer fromBinary
Parameters
- message: BinaryBuffer
  a binary buffer with the encoded message
- Optionalikm: Uint8Array<ArrayBufferLike>
  the input key material to derive the encryption key, if the message is encrypted
- Optionaladdress: Uint8Array<ArrayBufferLike>
  the binary encoded originator address, if the message is encrypted
- Optionaliv: Uint8Array<ArrayBufferLike>
  the initialisation vector, if required for the encryption method
Returns Promise<WfCoreMessage>
a new Whiteflag message object with the decoded message
- Defined in src/core/lib/message.ts:127

`Static`fromHex

fromHex(
    message: string,
    ikm?: string,
    address?: string,
    iv?: string,
): Promise<WfCoreMessage>
Creates new Whiteflag message from a hexadecimal encoded string
Parameters
- message: string
  atring with the hexadecimal encoded message
- Optionalikm: string
  the hexadecimalinput key material to derive the encryption key, if the message is encrypted
- Optionaladdress: string
  the hexadecimal encoded originator address, if the message is encrypted
- Optionaliv: string
  the hexadecimal initialisation vector, if required for the encryption method
Returns Promise<WfCoreMessage>
a new Whiteflag message object with the decoded message
- Defined in src/core/lib/message.ts:194

`Static`fromObject

fromObject(message: any): Promise<WfCoreMessage>
Function
Creates new Whiteflag message from a plain object fromObject
Parameters
- message: any
  a plain JavaScript object with message header and body
Returns Promise<WfCoreMessage>
a new Whiteflag message object
- Defined in src/core/lib/message.ts:162

`Static`fromU8a

fromU8a(
    message: Uint8Array,
    ikm?: Uint8Array<ArrayBufferLike>,
    address?: Uint8Array<ArrayBufferLike>,
    iv?: Uint8Array<ArrayBufferLike>,
): Promise<WfCoreMessage>
Creates new Whiteflag message from a binary encoded message
Parameters
- message: Uint8Array
  a Uint8Array with the binary encoded message
- Optionalikm: Uint8Array<ArrayBufferLike>
  the input key material to derive the encryption key, if the message is encrypted
- Optionaladdress: Uint8Array<ArrayBufferLike>
  the binary encoded originator address, if the message is encrypted
- Optionaliv: Uint8Array<ArrayBufferLike>
  the initialisation vector, if required for the encryption method
Returns Promise<WfCoreMessage>
a new Whiteflag message object with the decoded message
- Defined in src/core/lib/message.ts:217

Class WfCoreMessage

Wfversion

Wfreference

Remarks

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns WfCoreMessage

Methods

decode

Parameters

Returns Promise<WfCoreMessage>

encode

Parameters

Returns Promise<WfCoreMessage>

get

Parameters

Returns string | null

isEncoded

Returns boolean

isValid

Returns boolean

set

Parameters

Returns boolean

toHex

Returns string

toObject

Returns Object

toString

Returns string

toU8a

Returns Uint8Array

validate

Returns string[]

StaticfromBinary

Parameters

Returns Promise<WfCoreMessage>

StaticfromHex

Parameters

Returns Promise<WfCoreMessage>

StaticfromObject

Parameters

Returns Promise<WfCoreMessage>

StaticfromU8a

Parameters

Returns Promise<WfCoreMessage>

Settings

On This Page

`Static`fromBinary

`Static`fromHex

`Static`fromObject

`Static`fromU8a