npm.io
0.3.2 • Published 3 weeks ago

ehbp

Licence
MIT
Version
0.3.2
Deps
2
Size
352 kB
Vulns
0
Weekly
0
Stars
12

EHBP JavaScript Client

JavaScript/TypeScript client for Encrypted HTTP Body Protocol (EHBP).

EHBP encrypts HTTP request and response bodies end-to-end using HPKE (RFC 9180) while leaving headers in cleartext for routing.

Installation

npm install ehbp

Compatible Runtimes

  • Node.js 20+
  • Bun 1.x+
  • Browsers with ES2020 support

All HPKE key operations use @noble/curves (via @panva/hpke-noble) instead of WebCrypto, so X25519 support in the runtime's crypto.subtle is not required.

Quick Start

import { createTransport } from 'ehbp';

// Create transport (fetches server public key automatically)
const transport = await createTransport('https://example.com');

// Make encrypted requests - works like fetch()
const response = await transport.post('/api/data', JSON.stringify({ message: 'hello' }), {
  headers: { 'Content-Type': 'application/json' }
});

const data = await response.json();

API

createTransport(serverURL: string): Promise<Transport>

Creates a transport that automatically encrypts requests and decrypts responses.

const transport = await createTransport('https://example.com');
transport.request(input, init?): Promise<Response>

General-purpose method supporting all fetch options.

const response = await transport.request('/api/data', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ key: 'value' })
});
Convenience Methods
await transport.get('/users');
await transport.post('/users', body, options);
await transport.put('/users/123', body, options);
await transport.delete('/users/123');

Browser Usage

<script type="module">
  import { createTransport } from './dist/browser.js';

  const transport = await createTransport('https://example.com');
  const response = await transport.post('/api', 'Hello!');
  console.log(await response.text());
</script>

Development

npm install
npm run build
npm test
npm run build:browser  # Browser bundle
Running Examples (Node.js)

The Node.js example requires a build and an EHBP server running at http://localhost:8080:

# Build first
npm run build

# Start the Go server (from parent directory)
go run pkg/server/main.go

# Run the example (in another terminal)
npm run example
Running Examples (Browser)

Browser examples are located in examples/ and require the browser bundle:

# Build the browser bundle
npm run build:browser

# Start the local dev server
npm run serve

# Start the Go EHBP server (from parent directory, in another terminal)
go run pkg/server/main.go

Then open in your browser:

Example URL Description
test.html http://localhost:3000/examples/test.html POST and streaming tests (server: localhost:8080)
chat.html http://localhost:3000/examples/chat.html Chat interface demo (server: localhost:8443)

Note: chat.html connects to port 8443 and expects an OpenAI-compatible chat completions API.

Running Integration Tests

Integration tests verify streaming functionality against a live server:

# Start the Go server (from parent directory)
go run pkg/server/main.go

# Run integration tests (in another terminal)
npm run build
npm run test:integration
Commands
Command Description
npm test Run unit tests (no server required)
npm run test:integration Run streaming integration tests (requires server)
npm run example Run Node.js API demo (requires server)
npm run serve Start local server for browser examples

Protocol

See SPEC.md for the complete protocol specification.

Security

Report vulnerabilities to security@tinfoil.sh or open a GitHub issue.

Keywords