How-to

Encrypt a message

Goal

Turn a plaintext body into an encrypted wire envelope addressed to a specific recipient identity.

Prerequisites

• The SDK installed and an identity activated
• The recipient's identity name (an email address or hostname)

Code

.NET

using HexaEight.Bridge;

var client = new Client();

string envelope = await client.EncryptEnvelopeAsync(
    recipient: "[email protected]",
    body:      "hello alice");

Console.WriteLine($"Envelope length: {envelope.Length} bytes");
// Send `envelope` over any transport.

Node.js

import { HexaEight } from '@hexaeight/sdk';

const he = await HexaEight.connect();

const envelope = await he.envelope.encrypt({
    recipient: '[email protected]',
    body:      'hello alice',
});

console.log(`Envelope length: ${envelope.length} bytes`);

Optional parameters

What gets enforced automatically

If automatic enforcement is on (the default), the SDK runs an outbound authorisation check before encrypting. If a rule denies the operation, the SDK throws UnauthorizedAccessException in .NET (or UnauthorizedError in Node.js) and never produces an envelope.

try
{
    string envelope = await client.EncryptEnvelopeAsync("[email protected]", "hi");
}
catch (UnauthorizedAccessException ex)
{
    Console.WriteLine($"Outbound denied: {ex.Message}");
}

Common issues