Skip to content

auth.md

Latest commit

 

History

History
173 lines (123 loc) · 4.11 KB

auth.md

File metadata and controls

173 lines (123 loc) · 4.11 KB
Raw

Authentication & Authorization

A mongreldb-server daemon runs in one of three modes:

  1. Open (default) - no auth required.
  2. Bearer token (--auth-token <TOKEN>) - every request must carry an Authorization: Bearer <TOKEN> header.
  3. HTTP Basic (--auth-users) - every request must carry an Authorization: Basic <base64(user:pass)> header.

The D client supports all three through the four-argument constructor. This guide shows each mode and how to manage users and roles via SQL when the server is in Basic mode.

Bearer token mode

Start the daemon with a token:

mongreldb-server --auth-token s3cret-token

Connect with the token argument. It is sent as Authorization: Bearer ... on every request:

auto db = new MongrelDBClient(
    "http://127.0.0.1:8453",
    "s3cret-token",
    null,
    null);

if (db.health())
{
    writeln("healthy");
}

A missing or wrong token surfaces as AuthException (HTTP 401/403).

Where the token comes from

Hard-coding secrets in source is bad practice. Read it from the environment:

import std.process : environment;

auto token = environment.get("MONGRELDB_TOKEN");
if (token.length == 0)
{
    writeln("MONGRELDB_TOKEN not set");
    return;
}
auto db = new MongrelDBClient("http://127.0.0.1:8453", token, null, null);

Basic auth mode

Start the daemon with a users file or inline users:

mongreldb-server --auth-users

Connect with username / password:

auto db = new MongrelDBClient(
    "http://127.0.0.1:8453",
    null,
    "admin",
    "s3cret");

The client base64-encodes username:password and sets Authorization: Basic ... on every request.

Token takes precedence

If you supply both, token wins and Basic credentials are ignored. This lets you layer an override without branching:

auto db = new MongrelDBClient(
    url,
    "overrides-everything", // token wins
    "fallback",
    "user");

Per-request timeout

setTimeout(ms) sets the connect and data timeout for every request (default 30000 ms). It returns this, so it chains off construction:

auto db = (new MongrelDBClient("http://127.0.0.1:8453"))
    .setTimeout(60_000);

User and role management via SQL

When the daemon is in Basic auth mode, users and roles live in the catalog and are managed with SQL. Run these statements through db.sql.

Create a user

db.sql("CREATE USER alice WITH PASSWORD 'hunter2'");

Passwords are Argon2id-hashed by the daemon before storage.

Alter a user

Change a password:

db.sql("ALTER USER alice WITH PASSWORD 'new-password'");

Grant the admin role:

db.sql("ALTER USER alice ADMIN");

ALTER USER ... ADMIN is how you promote a user to full administrative privileges (table creation/drop, compaction, user management). Use it sparingly.

Drop a user

db.sql("DROP USER alice");

Roles and grants

db.sql("CREATE ROLE analyst");
db.sql("GRANT SELECT ON orders TO analyst");
db.sql("GRANT analyst TO alice");
db.sql("REVOKE SELECT ON orders FROM analyst");
db.sql("DROP ROLE analyst");

Exact grant syntax mirrors the server's SQL flavor; consult the server's SQL reference for the full GRANT/REVOKE grammar available in your build.

Common pitfalls

Auth errors look like other errors without a typed catch. A 401/403 maps to AuthException; a 404 maps to NotFoundException. Always catch the specific subclass rather than string-matching messages.

Forgetting to set auth in production. A client built with the default constructor sends no credentials. Against an auth-enabled daemon, every call throws AuthException. Centralize client construction so the auth arguments are never accidentally dropped.

Token in version control. Put secrets in the environment, a secret manager, or a file outside the repo. Never commit a real token.

Mixing modes. The daemon's auth mode is fixed at startup. A bearer token against a Basic-auth daemon (or vice versa) will not work.

Next steps