Automate Privacy Impact Assessment Checks
Run a data flow analysis so a new field that contains PII is flagged for review before it is added to the schema.
Task
Implement npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone to close a known attack surface before the next security review finds it.
When to use this
A penetration test report flags the missing npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone 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 npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone in the project configuration file with the recommended defaults.
npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone
Expected output: The configuration is accepted and npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone runs without errors on the first invocation.
2. Run the check locally to verify npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone 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 npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone blocks merge on failure.
- name: Run add privacy impact assessment
run: pnpm test
Expected output: Pull requests with failing npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phone 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. Run a data flow analysis so a new field that contains PII is flagged for review before it is added to the schema. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run npx privacy-scan –schema schema.graphql –pii-fields email,ssn,phone against the current codebase and inspect the output before wiring it into CI.
npx privacy-scan --schema schema.graphql --pii-fields email,ssn,phoneVerify and monitor
Once the gate is in place, make failures actionable. A failing npx privacy-scan –schema schema.graphql –pii-fields email,ssn,phone 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.