@exortek/apikey 1.0.0 → 1.0.2

package/dist/middleware/fastify.mjs

@@ -1,4 +1,3 @@
-import fp from 'fastify-plugin';
 import { timingSafeEqual as timingSafeEqual$1, createHmac, createHash } from 'node:crypto';
 
 /**
@@ -129,6 +128,67 @@ function isBuffer(value) {
   return Buffer.isBuffer(value);
 }
 
+let counter = 0;
+
+/**
+ * Mark a function as a Fastify plugin with encapsulation bypass.
+ *
+ * Drop-in replacement for the `fastify-plugin` npm package — covers
+ * the same symbols and option handling without the external dependency.
+ *
+ * @param {Function} fn               Plugin function `(fastify, opts) => …`
+ * @param {string | PluginOptions} [options]
+ *   A semver range string (shorthand for `{ fastify: range }`) or a
+ *   full options object.
+ * @returns {Function} The same function, decorated with plugin metadata.
+ *
+ * @typedef {object} PluginOptions
+ * @property {string} [name]          Display name. Auto-generated from
+ *                                    `fn.name` when omitted.
+ * @property {string} [fastify]       Semver range the plugin is compatible
+ *                                    with (e.g. `'>=4'`). Fastify checks
+ *                                    this at register time.
+ * @property {string[]} [decorators]  Decorators the plugin expects to
+ *                                    exist before it runs.
+ * @property {string[]} [dependencies] Plugins that must be registered
+ *                                    before this one.
+ * @property {boolean} [encapsulate]  When `true`, the plugin stays
+ *                                    encapsulated (skip-override = false).
+ *                                    Default `false` (skip override).
+ */
+function fastifyPlugin(fn, options) {
+  if (fn && fn.default !== undefined) {
+    fn = fn.default;
+  }
+
+  if (!isFunction(fn)) {
+    throw new TypeError(`fastifyPlugin expects a function, instead got '${typeof fn}'`);
+  }
+
+  let opts;
+  if (isString(options)) {
+    opts = { fastify: options };
+  } else if (isObject(options)) {
+    opts = { ...options };
+  } else {
+    opts = {};
+  }
+
+  if (!opts.name) {
+    opts.name = (fn.name || 'anonymous') + '-auto-' + counter++;
+  }
+
+  fn[Symbol.for('skip-override')] = opts.encapsulate !== true;
+  fn[Symbol.for('fastify.display-name')] = opts.name;
+  fn[Symbol.for('plugin-meta')] = opts;
+
+  if (!fn.default) {
+    fn.default = fn;
+  }
+
+  return fn;
+}
+
 /**
  * Imperative single-argument guard helpers — the everyday
  * `assertPositiveInt(x, 'name')` shape used at API boundaries.
@@ -786,11 +846,11 @@ function timingSafeEqual(a, b) {
  *
  * **Wire format:**
  *
- *     <prefix>_<base64url(16 random bytes)>_<base64url(32 random bytes)>
- *     ^^^^^^   ^^^^^^^^^^^^^^^^^^^^^^^^^   ^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *     type     id (128-bit — plaintext DB key)   secret (256-bit — HMAC'd)
+ *     <prefix>_<crockford-base32(16 random bytes)>_<crockford-base32(32 random bytes)>
+ *     ^^^^^^   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ *     type     id (128-bit, 26 chars)                secret (256-bit, 52 chars)
  *
- *   sk_live_QVI0RExDX01Fbg_pTk9UX0FfUkVBTF9LRVlfNDJfQVJUSVNBTkFMX1BJWk
+ *   sk_live_<id-26-chars>_<secret-52-chars>
  *
  * Stripe / GitHub / Anthropic all use this three-segment shape. The
  * split matters:
@@ -870,9 +930,9 @@ function hashSecret(secretBytes, pepper) {
 
 /**
  * Timing-safe compare of a candidate hash against a stored hash. Both
- * inputs are base64url strings of equal length — a length mismatch is
- * treated as a mismatch after a fixed decode step, so an outside
- * observer cannot learn the stored hash's length via timing.
+ * inputs are base64url strings. A length mismatch early-returns `false`
+ * — all stored hashes are fixed-length (43-char SHA-256 digests), so
+ * the length check leaks no information about the stored value.
  *
  * @param {string} candidate
  * @param {string} stored
@@ -913,15 +973,25 @@ function parseApiKey(key) {
   // secret use the base32-crockford alphabet which contains no
   // underscores — so the last two '_' cleanly bound them.
   const lastUnderscore = key.lastIndexOf('_');
-  if (lastUnderscore <= 0) {return null;}
+  if (lastUnderscore <= 0) {
+    return null;
+  }
   const prevUnderscore = key.lastIndexOf('_', lastUnderscore - 1);
-  if (prevUnderscore <= 0) {return null;}
+  if (prevUnderscore <= 0) {
+    return null;
+  }
   const prefix = key.slice(0, prevUnderscore);
   const id = key.slice(prevUnderscore + 1, lastUnderscore);
   const secret = key.slice(lastUnderscore + 1);
-  if (!PREFIX_RE.test(prefix)) {return null;}
-  if (id.length !== ID_CHARS || !CROCKFORD_RE.test(id)) {return null;}
-  if (secret.length !== SECRET_CHARS || !CROCKFORD_RE.test(secret)) {return null;}
+  if (!PREFIX_RE.test(prefix)) {
+    return null;
+  }
+  if (id.length !== ID_CHARS || !CROCKFORD_RE.test(id)) {
+    return null;
+  }
+  if (secret.length !== SECRET_CHARS || !CROCKFORD_RE.test(secret)) {
+    return null;
+  }
   return { prefix, id, secret };
 }
 
@@ -1328,45 +1398,36 @@ function _statusFor(reason) {
  *
  *   app.get('/v1/whoami', async req => req.apiKey);
  *
- * Wrapped with `fastify-plugin` so the `preHandler` hook and the
- * `req.apiKey` decorator escape encapsulation and apply to routes
- * registered as siblings in the parent scope. Register the plugin
- * inside a scoped `app.register(async scope => …)` block to control
- * which route group needs an API key — the usual Fastify pattern for
- * "protect only these routes with auth".
- *
- * `fastify-plugin` is an **optional peer** — install it with
- * `npm i fastify fastify-plugin` (or `yarn add`) alongside the fastify
- * runtime.  Not a hard dependency because Express-only consumers of
- * `@exortek/apikey` should not have to install it.
+ * The plugin bypasses Fastify's encapsulation so the `preHandler` hook
+ * and the `req.apiKey` decorator apply to routes in the parent scope.
+ * Register inside a scoped `app.register(async scope => …)` block to
+ * control which route group needs an API key.
  */
 
 
-async function apiKeyPluginFn(app, options) {
-  const config = normalizeOptions(options);
+const apiKeyPlugin = fastifyPlugin(
+  async function apiKeyPluginFn(app, options) {
+    const config = normalizeOptions(options);
 
-  app.decorateRequest(config.attach, null);
+    app.decorateRequest(config.attach, null);
 
-  app.addHook('preHandler', async (req, reply) => {
-    const ctx = {
-      getHeader: name => req.headers?.[name],
-      method: req.method,
-      ip: req.ip,
-      query: req.query,
-    };
-    const result = await runApiKey(ctx, config);
-    if (result.response) {
-      reply.code(result.response.status).send(result.response.body);
-      return reply;
-    }
-    req[config.attach] = result.verifyResult;
-    return undefined;
-  });
-}
-
-const apiKeyPlugin = fp(apiKeyPluginFn, {
-  fastify: '4.x || 5.x',
-  name: '@exortek/apikey',
-});
+    app.addHook('preHandler', async (req, reply) => {
+      const ctx = {
+        getHeader: name => req.headers?.[name],
+        method: req.method,
+        ip: req.ip,
+        query: req.query,
+      };
+      const result = await runApiKey(ctx, config);
+      if (result.response) {
+        reply.code(result.response.status).send(result.response.body);
+        return reply;
+      }
+      req[config.attach] = result.verifyResult;
+      return undefined;
+    });
+  },
+  { name: '@exortek/apikey' },
+);
 
 export { apiKeyPlugin };