Class: RiseMessage

new RiseMessage(solution, bodyopt, headopt)

Interface allowing for authenticated message exchange.

Parameters:

Name	Type	Attributes	Description
`solution`	module:rise~RiseSolution		Identity solution data.
`body`	Object.<string, string>	<optional>	Key-value data to include.
`head`	Object.<string, string>	<optional>	Additional headers.

Source: index.js, line 339

Members

body :Object.<string, string>|string

Key-value pairs given for the message.

Type:

Object.<string, string> | string

Source: index.js, line 355

head :module:rise~RiseMessage~Head

Default message headers, plus any custom ones supplied.

Type:

module:rise~RiseMessage~Head

Source: index.js, line 344

Methods

encrypt(publicKey) → {module:rise~EncryptedRiseMessage}

Encrypts the message state for the public key provided.

Parameters:

Name	Type	Description
`publicKey`	Uint8Array \| buffer	Recipient public key.

Source: index.js, line 365

Returns:

Type:: module:rise~EncryptedRiseMessage

sign(privateKey) → {module:rise~SignedRiseMessage}

Signs the message state using the private key provided.

Parameters:

Name	Type	Description
`privateKey`	Uint8Array \| buffer	Identity to use for signature.

Source: index.js, line 379

Returns:

Type:: module:rise~SignedRiseMessage

toBuffer() → {buffer}

Serializes the message to wire format.

Source: index.js, line 411

Returns:

Type:: buffer

unwrap() → {Object.<string, (string|module:rise~RiseMessage|module:rise~EncryptedRiseMessage|module:rise~SignedRiseMessage|string)>}

Returns only the body of this message.

Source: index.js, line 395

Returns:

Type:: Object.<string, (string|module:rise~RiseMessage|module:rise~EncryptedRiseMessage|module:rise~SignedRiseMessage|string)>

validate() → {boolean}

Ensures the solution header is valid.

Source: index.js, line 403

Returns:

Type:: boolean

(static) fromBuffer(message) → {module:rise~RiseMessage|module:rise~EncryptedRiseMessage|module:rise~SignedRiseMessage}

Creates a new message instance from the serialized message.

Parameters:

Name	Type	Description
`message`	buffer	Binary blob to deserialize.

Source: index.js, line 427

Returns:

Type:: module:rise~RiseMessage | module:rise~EncryptedRiseMessage | module:rise~SignedRiseMessage

Type Definitions

Head

Protocol headers included in every rise message.

Type:

object

Properties

Name	Type	Description
`nonce`	string	One-time token to prevent replay attacks.
`version`	string	Version of the rise package. Analagous to user agent.
`ciphertext`	boolean	Indicates if the message body should be treated as ciphertext (it is encrypted).
`solution`	module:rise~RiseSolution	Sender authentication data.

Source: index.js, line 322