@unkey/hono

Hono - [炎] means flame🔥 in Japanese - is a small, simple, and ultrafast web framework for the Edges. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, Vercel, Netlify, Lagon, AWS Lambda, Lambda@Edge, and Node.js.

@unkey/hono offers a middleware for authenticating API keys with unkey.

Install#

 npm install @unkey/hono

Let's dive straight in. The minimal setup looks like this. You need a root key with permission to verify keys. Go to /settings/root-keys and create a key with the verify_key permission.

By default it tries to grab the API key from the Authorization header and then verifies it with Unkey. The result of the verification will be written to the context and can be accessed with c.get("unkey").

import { Hono } from "hono";import { type UnkeyContext, unkey } from "@unkey/hono";const app = new Hono<{ Variables: { unkey: UnkeyContext } }>();app.use(  "*",  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,  }),);app.get("/somewhere", (c) => {  // access the unkey response here to get metadata of the key etc  const keyInfo = c.get("unkey");  return c.text(`Hello ${keyInfo.identity?.externalId ?? "user"}!`);});

Customizing the middleware#

Header#

By default the middleware tries to grab the API key from the Authorization header. You can change this by passing a custom header name to the middleware.

app.use(  "*",  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,    getKey: (c) => c.req.header("x-api-key"),  }),);

If the header is missing the middleware will return a 401 error response like this:

c.json({ error: "unauthorized" }, { status: 401 });

To customize the response in case the header is missing, just return a response from the getKey function.

app.use(  "*",  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,    getKey: (c) => {      const key = c.req.header("x-api-key");      if (!key) {        return c.text("missing api key", 401);      }      return key;    },  }),);

Handle errors#

app.use(  "*",  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,    onError: (c, err) => {      // handle error      return c.text("unauthorized", 401);    },  }),);

Handle invalid keys#

By default the middleware will not do anything with the verification response other than writing it to the context. However you most likely would like to just return a 401 response if the key is invalid and not continue with the request.

To do this you can pass a handleInvalidKey handler to the middleware. See the key verification docs for the full response object.

app.use(  "*",  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,    handleInvalidKey: (c, result) => {      return c.json(        {          error: "unauthorized",          reason: result.code,        },        401,      );    },  }),);

Pass verification tags#

You can pass tags to the verification request to help you filter keys later.

(c, next) =>  unkey({    rootKey: process.env.UNKEY_ROOT_KEY!,    tags: [`path=${c.req.path}`],  })(c, next);