hono 4.6.0: basicAuth

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify hono.basicAuth in pkg:npm/hono@4.6.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/hono@4.6.0
Demonstrate these symbols/APIs:
  - hono.basicAuth

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:dc9f7afee12a4d702b83c286e031d7c32b2c3d41a1acc6df56606100c1f98bf5","constraints":{"executionContext":"node"},"contract":["basicAuth throws an Error when initialized without username/password or verifyUser options","basicAuth allows authorized requests with valid basic credentials and passes to route handler","basicAuth responds with 401 and default WWW-Authenticate realm when Authorization header is missing","basicAuth responds with 401 when provided credentials do not match","basicAuth allows authentication across multiple configured users","basicAuth supports custom realm and custom invalidUserMessage options","basicAuth supports dynamic authentication using verifyUser callback"],"goal":"verify hono.basicAuth in pkg:npm/hono@4.6.0","kind":"HOW","packages":["pkg:npm/hono@4.6.0"],"schemaVersion":1,"symbols":["hono.basicAuth"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/hono@4.6.0"],"schemaVersion":1,"subject":"pkg:npm/hono@4.6.0","symbols":["hono.basicAuth"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-hono-basic-auth",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-hono-basic-auth",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "hono": "4.6.0"
      }
    },
    "node_modules/hono": {
      "version": "4.6.0",
      "resolved": "https://registry.npmjs.org/hono/-/hono-4.6.0.tgz",
      "integrity": "sha512-2jN7gHRCbfFXpHitg87ZDsComUB+PEm+rf2aDjy6e9SCwgnxkpQBCTKYumWQ4q4D3a+KuSW8VJAHzl4EnqYfeg==",
      "license": "MIT",
      "engines": {
        "node": ">=16.0.0"
      }
    }
  }
}

{
  "name": "sample-hono-basic-auth",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "dependencies": {
    "hono": "4.6.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify hono.basicAuth in pkg:npm/hono@4.6.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/hono@4.6.0"
  ],
  "symbols": [
    "hono.basicAuth"
  ]
}

import assert from 'node:assert/strict';
import { Hono } from 'hono';
import { basicAuth } from 'hono/basic-auth';

// Helper for Base64 Basic Auth header
const toBasicAuth = (user, pass) => 'Basic ' + Buffer.from(`${user}:${pass}`).toString('base64');

// Contract 1: basicAuth throws an Error when initialized without username/password or verifyUser options
{
  assert.throws(
    () => {
      basicAuth({});
    },
    {
      name: 'Error',
      message: 'basic auth middleware requires options for "username and password" or "verifyUser"',
    }
  );
}

// Contract 2: basicAuth allows authorized requests with valid basic credentials and passes to route handler
{
  const app = new Hono();
  app.use(
    '/protected/*',
    basicAuth({
      username: 'admin',
      password: 'secretpassword',
    })
  );
  app.get('/protected/resource', (c) => c.text('granted'));

  const req = new Request('http://localhost/protected/resource', {
    headers: {
      Authorization: toBasicAuth('admin', 'secretpassword'),
    },
  });

  const res = await app.request(req);
  assert.strictEqual(res.status, 200);
  assert.strictEqual(await res.text(), 'granted');
}

// Contract 3: basicAuth responds with 401 and default WWW-Authenticate realm when Authorization header is missing
{
  const app = new Hono();
  app.use(
    '/protected/*',
    basicAuth({
      username: 'admin',
      password: 'secretpassword',
    })
  );
  app.get('/protected/resource', (c) => c.text('granted'));

  const req = new Request('http://localhost/protected/resource');
  const res = await app.request(req);

  assert.strictEqual(res.status, 401);
  assert.strictEqual(res.headers.get('WWW-Authenticate'), 'Basic realm="Secure Area"');
  assert.strictEqual(await res.text(), 'Unauthorized');
}

// Contract 4: basicAuth responds with 401 when provided credentials do not match
{
  const app = new Hono();
  app.use(
    '/protected/*',
    basicAuth({
      username: 'admin',
      password: 'secretpassword',
    })
  );
  app.get('/protected/resource', (c) => c.text('granted'));

  const req = new Request('http://localhost/protected/resource', {
    headers: {
      Authorization: toBasicAuth('admin', 'wrongpassword'),
    },
  });
  const res = await app.request(req);

  assert.strictEqual(res.status, 401);
  assert.strictEqual(res.headers.get('WWW-Authenticate'), 'Basic realm="Secure Area"');
  assert.strictEqual(await res.text(), 'Unauthorized');
}

// Contract 5: basicAuth allows authentication across multiple configured users
{
  const app = new Hono();
  app.use(
    '/multi/*',
    basicAuth(
      { username: 'alice', password: 'alice-password' },
      { username: 'bob', password: 'bob-password' }
    )
  );
  app.get('/multi/hello', (c) => c.text('hello user'));

  const aliceReq = new Request('http://localhost/multi/hello', {
    headers: {
      Authorization: toBasicAuth('alice', 'alice-password'),
    },
  });
  const aliceRes = await app.request(aliceReq);
  assert.strictEqual(aliceRes.status, 200);
  assert.strictEqual(await aliceRes.text(), 'hello user');

  const bobReq = new Request('http://localhost/multi/hello', {
    headers: {
      Authorization: toBasicAuth('bob', 'bob-password'),
    },
  });
  const bobRes = await app.request(bobReq);
  assert.strictEqual(bobRes.status, 200);
  assert.strictEqual(await bobRes.text(), 'hello user');
}

// Contract 6: basicAuth supports custom realm and custom invalidUserMessage options
{
  const app = new Hono();
  app.use(
    '/custom/*',
    basicAuth({
      username: 'service',
      password: 'token',
      realm: 'Custom Realm',
      invalidUserMessage: { error: 'access_denied' },
    })
  );
  app.get('/custom/api', (c) => c.json({ ok: true }));

  const unauthorizedReq = new Request('http://localhost/custom/api');
  const unauthorizedRes = await app.request(unauthorizedReq);

  assert.strictEqual(unauthorizedRes.status, 401);
  assert.strictEqual(unauthorizedRes.headers.get('WWW-Authenticate'), 'Basic realm="Custom Realm"');
  assert.strictEqual(unauthorizedRes.headers.get('content-type'), 'application/json; charset=UTF-8');
  assert.deepStrictEqual(await unauthorizedRes.json(), { error: 'access_denied' });
}

// Contract 7: basicAuth supports dynamic authentication using verifyUser callback
{
  const app = new Hono();
  app.use(
    '/dynamic/*',
    basicAuth({
      verifyUser: async (username, password, c) => {
        return username === 'dynamicUser' && password === 'dynamicPass';
      },
    })
  );
  app.get('/dynamic/info', (c) => c.json({ authenticated: true }));

  const validReq = new Request('http://localhost/dynamic/info', {
    headers: {
      Authorization: toBasicAuth('dynamicUser', 'dynamicPass'),
    },
  });
  const validRes = await app.request(validReq);
  assert.strictEqual(validRes.status, 200);
  assert.deepStrictEqual(await validRes.json(), { authenticated: true });

  const invalidReq = new Request('http://localhost/dynamic/info', {
    headers: {
      Authorization: toBasicAuth('dynamicUser', 'wrongPass'),
    },
  });
  const invalidRes = await app.request(invalidReq);
  assert.strictEqual(invalidRes.status, 401);
}

console.log('All hono.basicAuth contract tests passed.');