Sign-In and Access
Sign-in works the way it does in StifleR. Access comes from the groups a person is in, never from the person directly.
Sign-in methods
Each method is a tab under Settings › Authentication. Several can be on at once.
| Method | Checks the password with | Groups you can bind |
|---|---|---|
| Built-In | ExecuteR's own accounts (PBKDF2-SHA512, at least 12 characters, changed at first sign-in) | Built-in groups |
| Local Windows Accounts | Windows, for this server's own accounts (LogonUser); Windows servers only |
The account's SID and its local groups' SIDs |
| LDAP | A directory or Active Directory over LDAPS, StartTLS or Kerberos | Group DNs, nested groups included |
| OIDC | Any OpenID Connect provider (authorization code with PKCE) | claim=value, e.g. groups=executer-admins |
The sign-in page (/sign-in) shows one password form and a
Sign In with {provider} button for OIDC. Redirect Mode sends people
straight to the provider when OIDC is the only method on, except after an
error or a sign-out.
OIDC callback to register with your provider:
<public-url>/api/auth/oidc/callback. Post-logout URL: <public-url>/sign-in.
Roles and bindings
A role is a set of permissions, optionally limited to a device scope (device groups). Admin, Operator and Viewer are seeded and can't be edited. Build your own under Access › Roles.
A role binding joins a group to a role. Each method's tab has a bindings card. Someone in several bound groups gets every one of those roles: permissions add up, and so do device scopes. A role without a scope reaches every device.
A person whose groups are bound to nothing is refused at sign-in.
Access › People lists everyone who has signed in, with each grant and the group it came through.
Sessions
- Storage: sessions are database rows behind an HTTP-only
__Host-sessioncookie, so a sign-out ends them on every node at once. - Lifetime: by default a session ends after 120 idle minutes, and after 12 hours whatever happens (Built-In tab › Sessions).
- CSRF: every write carries a CSRF token.
Safety rails
- Failed sign-ins back off per account and per address, from 30 seconds doubling up to 15 minutes.
- Turning a method on or off asks you to confirm it's you, with your password or your provider (step-up).
- The last method that is on can't be turned off.
- Leaving only LDAP, OIDC or Windows on needs a passed Test sign-in through it first.
- Secrets (the LDAP service password, the OIDC client secret) are write-only and encrypted at rest.
- Domain-joined Windows servers set up LDAP from the join until you change it. A breaker turns LDAP off after repeated directory failures.
Break-glass and recovery
One built-in account always has full access and can't be turned off. On an
empty database it's created from INITIAL_ADMIN_USERNAME /
INITIAL_ADMIN_PASSWORD. Without those, it's admin, with a one-time
password written once to the server log.
Locked out, for example because the identity provider is down:
AUTH_FORCE_LOCAL=1(environment only) always shows the built-in form.ExecuteR-Server auth-reset(in a container,dotnet Backend.dll auth-reset) turns Built-In sign-in back on, turns Redirect Mode off, and prints a new one-time password for the break-glass account. Add--user <name>to reset another built-in account.
Upgrading from earlier versions
Upgrading happens once, at first start:
- Users' roles: each user's role becomes membership of a built-in group named after the role, bound to that role.
- Old OIDC settings (saved, or
OIDC_*/AUTH_LOGIN_MODE) become the OIDC tab. - Claim-to-role mappings become
claim=valuebindings. - The old default role has no equivalent. Bind the claim your people carry instead.
/login links redirect to /sign-in.