Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.88 KB

next.md

File metadata and controls

73 lines (50 loc) · 2.88 KB
Raw

Next.js

At this moment, Zen only supports the standalone output in Next.js. To configure your Next.js app to use standalone output, you need to set the output property in your next.config.js file:

const nextConfig = {
  output: "standalone",
};

Next.js will create a standalone directory in your .next directory. This directory contains the standalone server that you can run with Node.js. Next.js will only copy dependencies that are required for the server to run. It does not know about @aikidosec/firewall, so you need to copy it manually:

mkdir -p .next/standalone/node_modules/@aikidosec
cp -r node_modules/@aikidosec/firewall .next/standalone/node_modules/@aikidosec

After building your Next.js app, you can run the standalone server with the following command:

node -r @aikidosec/firewall .next/standalone/server.js

If you're using Docker:

CMD node -r @aikidosec/firewall server.js

You can also use the firewall when developing locally by updating the dev and start scripts in your package.json:

{
  "scripts": {
    "build": "next build",
    "postbuild": "mkdir -p .next/standalone/node_modules/@aikidosec && cp -r node_modules/@aikidosec/firewall .next/standalone/node_modules/@aikidosec",
    "dev": "NODE_OPTIONS='-r @aikidosec/firewall' next dev",
    "start": "NODE_OPTIONS='-r @aikidosec/firewall' next start"
  }
}

You don't need to copy the @aikidosec/firewall directory when using npm run dev or npm run start.

Note: Including @aikidosec/firewall in middleware.js or instrumentation.js will not work due to the build process of Next.js.

Caveats

  1. Rate limiting by user ID is not supported because setUser is not supported due to the bundling process of Next.js.
  2. Same for blocking of specific users (requires setUser).
  3. Attack detection only works for modules that are listed in the serverComponentsExternalPackages. For example, pg is supported, but mysql is not.

Blocking mode

By default, Zen will run in detection only mode. When it detects an attack, the attack will be reported to Aikido and continue executing the call.

You can enable blocking mode by setting the environment variable AIKIDO_BLOCKING to true:

AIKIDO_BLOCKING=true node -r @aikidosec/firewall .next/standalone/server.js

It's recommended to enable this on your staging environment for a considerable amount of time before enabling it on your production environment (e.g. one week).

Debug mode

If you need to debug Zen, you can run your next app with the environment variable AIKIDO_DEBUG set to true:

AIKIDO_DEBUG=true node -r @aikidosec/firewall .next/standalone/server.js

This will output debug information to the console (e.g. if the agent failed to start, no token was found, unsupported packages, ...).