HexaEight.Bridge 1.0.0-preview9

Prefix Reserved
This is a prerelease version of HexaEight.Bridge.
dotnet add package HexaEight.Bridge --version 1.0.0-preview9
                    
NuGet\Install-Package HexaEight.Bridge -Version 1.0.0-preview9
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="HexaEight.Bridge" Version="1.0.0-preview9" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="HexaEight.Bridge" Version="1.0.0-preview9" />
                    
Directory.Packages.props
<PackageReference Include="HexaEight.Bridge" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add HexaEight.Bridge --version 1.0.0-preview9
                    
#r "nuget: HexaEight.Bridge, 1.0.0-preview9"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package HexaEight.Bridge@1.0.0-preview9
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=HexaEight.Bridge&version=1.0.0-preview9&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=HexaEight.Bridge&version=1.0.0-preview9&prerelease
                    
Install as a Cake Tool

HexaEight.Bridge

NuGet License: Apache-2.0 Docs

Universal integration layer for HexaEight cryptographic identity and Dead Drop Encryption. One small .NET assembly that lets any language (Node.js, Python, .NET native — Go, Rust coming) consume the HexaEight platform with the same API surface.

The Bridge is the layer every HexaEight SDK is built on top of.

Install

dotnet add package HexaEight.Bridge --prerelease

Multi-targets net8.0, net9.0, net10.0. NuGet picks the right one for your host.

Five-line example

using HexaEight.Bridge;

var client = new Client();
string envelope = await client.EncryptEnvelopeAsync("alice.example.com", "Hello Alice!");
var msg = await client.DecryptEnvelopeAsync(envelope);
Console.WriteLine($"{msg.From}: {msg.Body}");

No key exchange. No PKI. No prior provisioning of the recipient. Just send.

API cheat sheet

Method What it does
new Client() Loads your identity from env-file + hexaeight.mac (or hexaeightkeys.db on Azure).
client.Name, client.SourceId Your fully-qualified identity and login-token prefix.
EncryptEnvelopeAsync(recipient, body, kgt?, pinAsk?, sessionId?) Returns a single envelope string. Variant A by default; Variant B if sessionId is set.
DecryptEnvelopeAsync(envelope, pinAsk?) Auto-detects variant. Returns DecryptedEnvelope { From, Body, Kgt, Kind, SessionId }.
Client.InspectEnvelope(envelope) (static) Parses public metadata without decrypting — for deny-list filtering.
FetchAskAsync(recipient, kgt) Pre-warm the ASK cache.
PinAsk(recipient, kgt) / PinAskForSession(sessionId, ask) Mark a cache entry as preferred.
UnpinAsk(...) / UnpinAskForSession(...) Remove the preference.
HasAsk(...) / HasAskForSession(...) Test cache presence without fetching.
ClearAskCache(recipient?, sessionId?) Remove entries. No args = clear all.
SaveAskCacheAsync(path) / LoadAskCacheAsync(path) JSON persistence.
EnableAutoPersist(path, interval?) Flush cache every N seconds. Cancels on Dispose().

For the full reference — parameters, return types, error semantics, performance numbers, wire format spec, and conceptual guides — see hexaeight.com/docs/reference/bridge.

Wire format

Envelope strings come in two variants:

Standard:    {sourceId}|{kgt}|{ciphertext}
Sessioned:   hsha:{sha256(sessionId)}|{ciphertext}

Full spec at hexaeight.com/docs/reference/wire-format.

Identity load order

The Bridge looks for credentials in this order, stopping at the first hit:

  1. Azure modehexaeightkeys.db (SQLite) in the current working directory.
  2. Environment variableHEXAEIGHT_MACHINETOKEN.
  3. Env-fileenv-file in the current working directory with a HEXAEIGHT_MACHINETOKEN=… line.

The Bridge is read-only with respect to your environment — it never sets environment variables.

Cross-language use

The same Client class is reachable from:

  • Node.js via node-api-dotnet under dotnet.HexaEight.Bridge.Client — packaged as @hexaeight/sdk.
  • Python via pythonnet in the HexaEight.Bridge namespace — packaged as hexaeight-sdk (in progress).

Method names, parameters, and return shapes are identical across languages. Each SDK exposes the surface in idiomatic style (camelCase for JS/TS, snake_case for Python).

For AI agents

A flat-text mirror of the full API reference is at hexaeight.com/llms-full.txt. The site-wide index follows the llms.txt convention at hexaeight.com/llms.txt.

License

Apache License 2.0. The Bridge is open-source plumbing; the underlying HexaEight cipher implementation (Dead Drop Encryption) is delivered as closed-source NuGet packages (HexaEightASKClientLibrary, HexaEightJWTLibrary) and is patent-pending.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-preview9 55 6/6/2026
1.0.0-preview7 65 6/5/2026
1.0.0-preview6 68 5/26/2026
1.0.0-preview5 54 5/26/2026
1.0.0-preview18 39 6/12/2026
1.0.0-preview17 39 6/12/2026
1.0.0-preview16 41 6/12/2026
1.0.0-preview15 45 6/11/2026
1.0.0-preview13 43 6/9/2026
1.0.0-preview12 46 6/8/2026
1.0.0-preview11 61 6/7/2026
1.0.0-preview10 48 6/6/2026