← Recipes

阅读中文版本

Validate All Inputs with a Zod Schema

Parse every request body and query param through a Zod schema so malformed input is rejected with a 400 before it reaches the handler.

~20 minsecurityvalidationzod

Task

Implement const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); to close a known attack surface before the next security review finds it.

When to use this

A penetration test report flags the missing const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); as a medium-severity finding on a public endpoint.

Prerequisites

  • A running application with the vulnerable endpoint
  • Access to security headers or middleware config

Steps

1. Configure const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); in the project configuration file with the recommended defaults.

const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error);

Expected output: The configuration is accepted and const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); runs without errors on the first invocation.

2. Run the check locally to verify const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); blocks merge on failure.

- name: Run add input validation zod schema
  run: pnpm test

Expected output: Pull requests with failing const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Close the attack surface

Start by measuring the problem. Parse every request body and query param through a Zod schema so malformed input is rejected with a 400 before it reaches the handler. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); against the current codebase and inspect the output before wiring it into CI.

const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error);

Verify and monitor

Once the gate is in place, make failures actionable. A failing const parsed = UserSchema.safeParse(req.body); if (!parsed.success) return res.status(400).json(parsed.error); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.