Skip to main content
skill CX Codex

convex-security-check — Claude Code skill: security check

Checks a Convex backend before merge for exposed functions, missing auth, weak validation, ownership gaps, and secrets in code.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add waynesutton/builder-skills --skill convex-security-check -a claude-code
Open on GitHub

What convex-security-check does

This skill scans convex/ with rg for exported query, mutation, and action handlers that may need to be internal. It also looks for api.* calls from backend code, HTTP routes, and storage URL usage.

It flags public handlers with no identity check, missing argument validators, and v.any() fields. Client-supplied IDs get special attention: v.id() confirms a table-shaped ID, not that the caller owns the document. That means each get, patch, delete, and replace hit needs an ownership or membership check.

The checks cover secret-like values and process.env reads in src/, plus authentication on HTTP routes. This skill finds recurring issues rather than mapping the whole system; convex-security-audit is named for a full audit.

What it helps with

  • find public handlers that should be internal
  • spot mutations without identity checks
  • catch client IDs used without ownership checks
  • detect missing validators and v.any()
  • search for secrets in convex/ and src/

Example prompts for the agent

  • Run a quick security check on the Convex backend.
  • Review convex/ before I merge this change.
  • Check the new public mutation handlers for auth and document ownership.

How to install convex-security-check

1Skills CLI (Vercel)

npx skills add waynesutton/builder-skills --skill convex-security-check -a claude-code

2Manually: put the files in place

~/.claude/skills/convex-security-check/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/convex-security-check/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about convex-security-check

How do I install convex-security-check in Claude Code?

Run npx skills add waynesutton/builder-skills --skill convex-security-check -a claude-code, then run npx skills add waynesutton/builder-skills --skill convex-security-check -a claude-code again. The skill file is at ~/.claude/skills/convex-security-check/SKILL.md.

What does convex-security-check do?

It performs a focused security pass over a Convex backend. The checks cover public endpoints, authentication, argument validation, document ownership, HTTP routes, storage access, and secrets.

Why is v.id("tasks") not enough for authorization?

It validates that the value is an ID for the tasks table. It does not show that the caller owns that document, so the handler must compare ownership using identity and stored data.

Source text

SKILL.md · Apache-2.0
---
name: convex-security-check
description: Ten minute security pass over a Convex backend: public functions that should be internal, missing auth checks, unvalidated args, IDs from the client trusted without ownership checks, secrets in code. Use before merging a pull request, after adding new public functions, or when the user says 'quick security check'.
---

# Convex security check

A ten minute pass over `convex/` that catches the mistakes that ship most often. The one rule: every exported `query`, `mutation`, and `action` is a public endpoint anyone can call with any arguments, so each one must check identity and ownership or be intentionally anonymous.

Run each grep, read what it surfaces, fix or file. This skill finds problems; it does not map the whole system. For that, hand off to convex-security-audit.

## When to reach for this

- Before merging a pull request that touches `convex/`
- After adding or renaming public functions
- The user says "quick security check", "sanity check the backend", or "anything obviously wrong here"
- Before a dev to prod push, when there is no time for a full audit

## Checklist

Run the commands from the project root. Every grep excludes `_generated`.

### 1. Public vs internal

Anything only called by other Convex functions, the scheduler, crons, or webhooks should be `internalQuery`, `internalMutation`, or `internalAction`.

```bash
rg -n "export const \w+ = (query|mutation|action)\(" convex --glob '!**/_generated/**'
rg -n "\bapi\.\w+\.\w+" convex --glob '!**/_generated/**'
```

The second grep finds `api.*` used inside the backend. Server code scheduling or running a public function is almost always a sign that function should be internal.

- [ ] Every public function has a client that needs to call it
- [ ] No `api.*` inside `ctx.scheduler.*`, `ctx.run*`, or `crons.*`
- [ ] Admin only operations (role changes, credit grants, deletions across users) are internal

### 2. Auth

```bash
rg -l "= (query|mutation|action)\(" convex --glob '!**/_generated/**' \
  | xargs rg -L "getUserIdentity|getCurrentUser|authedQuery|authedMutation"
```

Files listed contain public functions and no auth call at all. Open each one. A public post list is fine anonymous. Anything that returns or writes user data is not.

- [ ] Every public function checks identity or is documented as intentionally anonymous
- [ ] Auth helpers throw or return early when identity is missing
- [ ] Roles come from the `users` table, never from client arguments

### 3. Validation

```bash
rg -nU "(query|mutation|action)\(\{\s*handler" convex --glob '!**/_generated/**'
rg -n "v\.any\(\)" convex --glob '!**/_generated/**'
```

The first grep finds functions whose definition starts with `handler`, meaning no `args`. The second finds `v.any()`, which turns off validation for that field.

- [ ] Every function has `args` and `returns` validators
- [ ] No `v.any()` on arguments that reach the database or an external API
- [ ] Return validators list fields explicitly so `passwordHash`, `stripeCustomerId`, and internal flags cannot leak

### 4. Ownership and IDs

`v.id("tasks")` proves the string is a valid ID for that table. It does not prove the caller owns the document.

```bash
rg -n "ctx\.db\.(get|patch|delete|replace)\(args\." convex --glob '!**/_generated/**'
rg -n "userId: v\.(id|string)\(" convex --glob '!**/_generated/**'
```

For each hit in the first grep, find the ownership comparison between the read and the write. For the second, a public function that accepts the caller's own `userId` as an argument is trusting the client to say who it is.

- [ ] Every `get`, `patch`, `delete`, `replace` by a client supplied ID is followed by an ownership or membership check
- [ ] Caller identity is derived from `ctx.auth`, never accepted as an argument
- [ ] Lists use `withIndex` on the owner field, not a full scan plus filter

### 5. Secrets

```bash
rg -n -i "(sk_live|sk_test|whsec_|AKIA[0-9A-Z]{16}|-----BEGIN|api[_-]?key\s*[:=]\s*['\"][A-Za-z0-9])" convex src --glob '!**/_generated/**'
rg -n "process\.env\." src
```

Anything in `src/` that reads `process.env` or `import.meta.env` ships to the browser. Only deployment URLs and public client IDs belong there.

- [ ] No secret literals in `convex/`, `src/`, tests, or fixtures
- [ ] Secrets read from `process.env` inside the action or HTTP action that uses them
- [ ] Dev and prod deployments use different keys

### 6. HTTP and storage

```bash
rg -n "http\.route|httpAction\(" convex/http.ts
rg -n "storage\.(generateUploadUrl|getUrl)" convex --glob '!**/_generated/**'
```

- [ ] Every `http.ts` route verifies its caller (webhook signature, bearer token, or `getUserIdentity`) before parsing the body
- [ ] Routes call `internal.*`, not `api.*`
- [ ] `generateUploadUrl` requires auth
- [ ] `getUrl` is called on a storage ID read from a document the caller owns, never on a storage ID passed by the client

## One fix, before and after

The most common finding: auth is checked, ownership is not.

Before:

```typescript
export const updateTask = mutation({
  args: { taskId: v.id("tasks"), title: v.string() },
  returns: v.null(),
  handler: async (ctx, args) => {
    const identity = await ctx.auth.getUserIdentity();
    if (!identity) throw new ConvexError("Sign in required");
    // any signed in user can rename any task
    await ctx.db.patch(args.taskId, { title: args.title });
    return null;
  },
});
```

After:

```typescript
import { mutation } from "./_generated/server";
import { v, ConvexError } from "convex/values";
import { getCurrentUser } from "./lib/auth";

export const updateTask = mutation({
  args: { taskId: v.id("tasks"), title: v.string() },
  returns: v.null(),
  handler: async (ctx, args) => {
    const user = await getCurrentUser(ctx); // throws when signed out
    const task = await ctx.db.get(args.taskId);
    // same error for missing and not owned, so IDs cannot be probed
    if (!task || task.userId !== user._id) {
      throw new ConvexError({ code: "NOT_FOUND", message: "Task not found" });
    }
    await ctx.db.patch(args.taskId, { title: args.title });
    return null;
  },
});
```

`getCurrentUser` looks the user up through a `by_tokenIdentifier` index using `identity.tokenIdentifier` and throws when there is no identity. Define it once in `convex/lib/auth.ts` and use it everywhere.

## Common mistakes

| Mistake | Why it breaks | Do this instead |
| --- | --- | --- |
| Checking auth in the React component only | Anyone can call the function from the dashboard or a script | Check in the handler |
| `v.id("users")` argument for "the current user" | Client can pass any user's ID | Derive from `ctx.auth.getUserIdentity()` |
| Comparing ownership to `identity.email` | Emails can be reused or unverified | Compare to `user._id` |
| `internalMutation` treated as safe on its own | The public caller may pass unverified IDs | Check the call site too |
| Fixing one hit and moving on | The same pattern usually appears in siblings | Fix all hits from the grep |

## Hand off to convex-security-audit

Stop and run the full audit when any of these are true:

- More than two or three findings in steps 2 or 4; the pattern is systemic
- The app has multi tenant data (orgs, teams, workspaces)
- `http.ts` has webhook routes or routes that return user data
- Files are uploaded and served
- The user asks for a report, a launch review, or a post incident review

The audit maps auth per function, data access per table, HTTP exposure, storage, scheduler trust, rate limiting, and produces a written findings report. This check does not.

## Docs

- https://docs.convex.dev/llms.txt
- https://docs.convex.dev/auth/functions-auth
- https://docs.convex.dev/functions/internal-functions
- https://docs.convex.dev/functions/validation

© waynesutton · Apache-2.0 · waynesutton/builder-skills

Similar skills

Everything for Security →

From the same set14

convex-functions Writes Convex queries, mutations and actions in the object form, with args and returns validators, correct ctx usage and runtime boundaries. CX Codex +1 3,200installs convex-schema-validator Designs Convex tables, validators, indexes, and document relationships in convex/schema.ts. Use it when a schema changes or validation fails during development. CX Codex +1 3,000installs convex-realtime A skill for wiring React to Convex subscriptions: useQuery patterns, optimistic updates, pagination that stays live, and cutting subscription churn. CX Codex +1 2,900installs convex-cron-jobs Sets up recurring jobs in convex/crons.ts and delayed execution with ctx.scheduler. Helps batch heavy mutations and debug failing queues in Convex. CX Codex +1 2,800installs convex-http-actions Adds HTTP endpoints in convex/http.ts: webhook receivers with signature checks, REST routes, CORS, streaming and file uploads. CX Codex +1 2,700installs convex-migrations Walks a live Convex schema change through six steps: optional field, batched backfill, validator flip, cleanup. Useful when npx convex dev rejects existing documents. CX Codex +1 2,600installs convex-file-storage Handles Convex file storage operations: upload URLs, blob persistence in actions, and serving with getUrl. Useful when building user uploads or fetching external assets. CX Codex +1 2,600installs convex-agents Guides agent setup with the @convex-dev/agent component. Useful when adding chat threads, tool calling for queries and mutations, or RAG to a Convex app. CX Codex +1 1,500installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor