Summary
- You run it. Nullwake is a set of containers on your own VM or container platform. There is no Nullwake cloud, no telemetry and no licence server.
- Read-only. It connects with a warehouse role that can only read the tables you list. On Postgres every session is also opened read-only with a statement timeout.
- Aggregates, not rows. Built-in checks read back counts, ages, null and duplicate counts, and column names and types. No result rows are copied.
- Credentials stay with you. Contracts name environment variables. A contract containing an inline secret is rejected.
- You choose what goes out. The only outbound traffic is to your warehouse, the alert channels you configure, and an optional heartbeat URL you set.
- Open source. The code is Apache 2.0 on GitHub, so you can read every line you deploy.
What Nullwake reads
Each check generates one query and stores only its aggregate result.
| Check | Reads back |
|---|---|
| Freshness | The newest timestamp in one column, as an age in minutes |
| Volume | Row counts per time window |
| Schema | Column names, types and nullability from the information schema |
| Not null, unique | Counts of null values and of duplicate keys |
| Custom rule | One number returned by a single SELECT that your team writes and reviews |
About custom rules. A custom rule's number appears in its alert message, so review rule SQL in pull requests like any other code: it should return a count or another approved aggregate. Anyone with the editor role can add rules, so treat editors as trusted warehouse readers and keep the warehouse role's grants to the contracted tables.
Error messages are redacted. Databases often quote the offending value in an error. Nullwake stores and alerts only the error class and SQLSTATE, for example query failed: data exception (SQLSTATE 22P02). Full error text is not logged unless an operator turns it on while debugging.
What leaves your network
Nullwake makes these outbound connections and no others.
| Destination | What is sent | When |
|---|---|---|
| Your warehouse | Generated read-only queries | Always. A hosted warehouse such as Snowflake or BigQuery sits outside your network. |
| Slack or your webhook | Check, contract and dataset names, the owner, severity, timestamps, a message with aggregate values, and a link to the incident | Only if you configure an alert channel |
| Heartbeat URL | A plain request with no content | Only if you set one |
An alert looks like orders.freshness on analytics.fct_orders: data is 3 h old (limit 20 min). If table or owner names are themselves sensitive, send alerts to a webhook inside your network instead of Slack. Webhooks are signed with HMAC-SHA256 and a timestamp, so your receiver can reject forged or replayed calls.
Warehouse access
Create a dedicated role that can read only the tables under contract. Where you can, grant individual tables rather than whole schemas, and give Nullwake its own small warehouse so its cost is visible and bounded.
Postgres
CREATE ROLE nullwake_reader LOGIN PASSWORD '…';
GRANT USAGE ON SCHEMA analytics TO nullwake_reader;
GRANT SELECT ON ALL TABLES IN SCHEMA analytics TO nullwake_reader;
ALTER ROLE nullwake_reader SET default_transaction_read_only = on;
Nullwake also opens every session read-only and sets a statement timeout (60 seconds by default).
Snowflake
CREATE ROLE NULLWAKE_READER;
GRANT USAGE ON WAREHOUSE MONITORING_XS TO ROLE NULLWAKE_READER;
GRANT USAGE ON DATABASE ANALYTICS TO ROLE NULLWAKE_READER;
GRANT USAGE ON ALL SCHEMAS IN DATABASE ANALYTICS TO ROLE NULLWAKE_READER;
GRANT SELECT ON ALL TABLES IN DATABASE ANALYTICS TO ROLE NULLWAKE_READER;
CREATE USER NULLWAKE_SVC TYPE = SERVICE
DEFAULT_ROLE = NULLWAKE_READER RSA_PUBLIC_KEY = '…';
GRANT ROLE NULLWAKE_READER TO USER NULLWAKE_SVC;
Use key-pair authentication with a service user, so there is no password at all. Sessions carry a statement timeout and the query tag nullwake, so you can find and cost every Nullwake query in your query history. Snowflake has no read-only session mode, so the role is the boundary: never give Nullwake a role that can write.
BigQuery
A service account with roles/bigquery.dataViewer on the datasets and roles/bigquery.jobUser on the project. Every query carries a billing cap (10 GiB by default, adjustable) and the label tool=nullwake.
Credentials
- Connection and alert settings only name environment variables, such as
dsnEnv: WAREHOUSE_DSN. Settings that look like an inline password or key are rejected when the contract is applied. - Passwords, keys and webhook secrets live in your environment or secret manager, never in YAML or Git.
- To rotate a credential, update the environment and restart the worker. Nothing in the database changes.
Application security
| Area | How it works |
|---|---|
| Sign-in | Passwords hashed with Argon2id. Sign-in is throttled to 10 failed attempts per address and per account every 15 minutes. |
| Sessions | Random 256-bit tokens, stored only as hashes, secure cookies, 8-hour lifetime, revoked when a password or role changes. |
| Roles | Viewer (read), editor (acknowledge, resolve, run and apply contracts) and admin (connections, alert channels, API tokens, audit log). |
| API tokens | Role-scoped, stored hashed, revocable, with last-used tracking. |
| Web interface | Ships no JavaScript and sends a strict Content-Security-Policy. Every form is protected against cross-site request forgery. |
| Audit log | Sign-ins, contract changes, acknowledgements, resolutions, notes, schema changes accepted, and token creation and revocation. |
| Containers | Run as a non-root user with a read-only filesystem, all Linux capabilities dropped, and privilege escalation disabled. |
Known limitations
Stated plainly so they surface in your review rather than after it.
- No single sign-on yet. Accounts are local. OIDC single sign-on is on the roadmap; until then you can put Nullwake behind your identity-aware proxy.
- One organisation per deployment. There is no multi-tenancy, which also means no data is shared between customers.
- Single host as shipped. The bundled setup has no high availability. Nullwake's own state is one Postgres database: back it up daily, and test a restore before production. Instructions are in the operations guide.
- Internal endpoints. Metrics and readiness endpoints have no authentication and are blocked at the bundled proxy. Expose them only on internal networks.
- Early product. Nullwake is at version 0.6. Postgres is tested end to end, and Snowflake and BigQuery are verified against live accounts.
Questions and reports
For security questions, a call with your security team, or to report a vulnerability, email hello@nullwake.si. The technical detail behind this page is in docs/security.md.