LDAP/Active Directory

LDAP authentication requires an Enterprise Edition license.

Dockhand integrates with LDAP directories including Active Directory, OpenLDAP, FreeIPA, and other RFC 4511-compliant servers. Users authenticate with their directory credentials, and group memberships map to Dockhand roles.

Prerequisites

Enterprise License - LDAP is an Enterprise-only feature
LDAP Server - Active Directory, OpenLDAP, FreeIPA, etc.
Network Access - Dockhand must reach the LDAP server (port 389 or 636)
Service Account (recommended) - For user/group searches

Configuration

1. Configure LDAP Provider

Navigate to Settings > Authentication > LDAP and click Add Configuration. Or via API:

curl -X POST http://localhost:8000/api/auth/ldap \
  -H "Content-Type: application/json" \
  -H "Cookie: dockhand_session=YOUR_SESSION_TOKEN" \
  -d '{
    "name": "Active Directory",
    "enabled": true,
    "serverUrl": "ldap://dc.example.com:389",
    "bindDn": "CN=Service Account,OU=Service Accounts,DC=example,DC=com",
    "bindPassword": "service_account_password",
    "baseDn": "DC=example,DC=com",
    "userFilter": "(sAMAccountName={{username}})",
    "usernameAttribute": "sAMAccountName",
    "emailAttribute": "mail",
    "displayNameAttribute": "displayName",
    "tlsEnabled": false
  }'

{
  "id": 1,
  "name": "Active Directory",
  "enabled": true,
  "serverUrl": "ldap://dc.example.com:389",
  "bindDn": "CN=Service Account,OU=Service Accounts,DC=example,DC=com",
  "bindPassword": "********",
  "baseDn": "DC=example,DC=com",
  "userFilter": "(sAMAccountName={{username}})",
  "usernameAttribute": "sAMAccountName",
  "emailAttribute": "mail",
  "displayNameAttribute": "displayName",
  "tlsEnabled": false,
  "createdAt": "2026-03-04T10:00:00Z"
}

Configuration Fields

name

string

required

Display name for the LDAP provider (e.g., “Active Directory”, “OpenLDAP”)

enabled

boolean

default:"false"

Enable/disable this provider without deleting configuration

serverUrl

string

required

LDAP server URL with protocol and port.Examples:

ldap://dc.example.com:389 (plain LDAP)
ldaps://dc.example.com:636 (LDAP over TLS)
ldap://10.0.1.10:389

bindDn

string

Service account DN for searching users/groups. Optional if allowing anonymous bind.Examples:

Active Directory: CN=Service Account,OU=Service Accounts,DC=example,DC=com
OpenLDAP: cn=admin,dc=example,dc=com

bindPassword

string

Password for the service account (stored encrypted)

baseDn

string

required

Base DN for user searches. All users must be under this DN.Examples:

DC=example,DC=com
OU=Users,DC=example,DC=com
ou=people,dc=example,dc=org

userFilter

string

default:"(uid={{username}})"

LDAP filter to find users. {{username}} is replaced with the login username.Common Filters:

Active Directory: (sAMAccountName={{username}})
OpenLDAP: (uid={{username}})
Email login: (mail={{username}})
Multiple: (|(uid={{username}})(mail={{username}}))

usernameAttribute

string

default:"uid"

LDAP attribute containing the usernameCommon Values:

Active Directory: sAMAccountName
OpenLDAP: uid
Email: mail

emailAttribute

string

default:"mail"

LDAP attribute containing the email address

displayNameAttribute

string

default:"cn"

LDAP attribute containing the full nameCommon Values:

cn (common name)
displayName
givenName (first name only)

groupBaseDn

string

Base DN for group searches (required for role mappings)Examples:

OU=Groups,DC=example,DC=com
ou=groups,dc=example,dc=org

groupFilter

string

Custom LDAP filter for group membership checks. Available placeholders:

{{username}} - Login username
{{user_dn}} - User’s distinguished name
{{group}} - Group DN or name

Examples:

(member={{user_dn}})
(memberUid={{username}})

adminGroup

string

Group DN or name for admin access. Users in this group receive the Admin role.Examples:

Full DN: CN=Dockhand Admins,OU=Groups,DC=example,DC=com
Group name: dockhand-admins (searches in groupBaseDn)

roleMappings

array

Map LDAP groups to Dockhand roles. JSON array of mappings.Example:

[
  {"groupDn": "CN=Docker Admins,OU=Groups,DC=example,DC=com", "roleId": 2},
  {"groupDn": "CN=Docker Viewers,OU=Groups,DC=example,DC=com", "roleId": 3}
]

tlsEnabled

boolean

default:"false"

Use LDAP over TLS (LDAPS). Requires server certificate trust.

tlsCa

string

PEM-encoded CA certificate for TLS validation. If not provided, system CAs are used.

Testing Configuration

Test your LDAP connection before enabling:

curl -X POST http://localhost:8000/api/auth/ldap/1/test \
  -H "Cookie: dockhand_session=YOUR_SESSION_TOKEN"

{
  "success": true,
  "userCount": 142
}

This performs a test search for users matching the configured filter (with * as username).

Authentication Flow

1. User Submits Credentials

User enters username and password on the login page.

2. Search for User DN

Dockhand binds with the service account and searches for the user:

baseDn: DC=example,DC=com
filter: (sAMAccountAccount=alice)
attributes: dn, sAMAccountName, mail, displayName

The username is escaped to prevent LDAP injection:

function escapeLdapFilterValue(value: string): string {
  return value
    .replace(/\\/g, '\\5c')
    .replace(/\*/g, '\\2a')
    .replace(/\(/g, '\\28')
    .replace(/\)/g, '\\29')
    .replace(/\0/g, '\\00');
}

This prevents attackers from injecting wildcards or closing parentheses.

3. Bind as User

Dockhand attempts to bind as the found user DN with the provided password:

bindDn: CN=Alice Johnson,OU=Users,DC=example,DC=com
password: user_provided_password

If the bind succeeds, the password is correct.

4. Extract User Attributes

Dockhand extracts user information from the LDAP entry:

const username = entry.sAMAccountName;    // "alice"
const email = entry.mail;                 // "[email protected]"
const displayName = entry.displayName;    // "Alice Johnson"

5. Check Admin Group Membership

If adminGroup is configured, check if the user is a member:

baseDn: CN=Dockhand Admins,OU=Groups,DC=example,DC=com
scope: base
filter: (member=CN=Alice Johnson,OU=Users,DC=example,DC=com)

If found, user receives the Admin role.

6. Process Role Mappings

For each configured role mapping, check group membership:

# Check membership in "Docker Viewers" group
baseDn: CN=Docker Viewers,OU=Groups,DC=example,DC=com
scope: base
filter: (member=CN=Alice Johnson,OU=Users,DC=example,DC=com)

Assign/remove roles based on current group memberships.

7. Create/Update Local User

Dockhand creates or updates a local user account:

let user = await getUserByUsername('alice');
if (!user) {
  user = await createUser({
    username: 'alice',
    email: '[email protected]',
    displayName: 'Alice Johnson',
    passwordHash: '', // No local password for LDAP users
    authProvider: 'ldap:Active Directory'
  });
}

8. Create Session

Dockhand creates a session and logs the user in:

const session = await createUserSession(user.id, 'ldap', cookies, request);

Active Directory Examples

Standard Configuration

{
  "name": "Active Directory",
  "serverUrl": "ldap://dc.example.com:389",
  "bindDn": "CN=Dockhand Service,OU=Service Accounts,DC=example,DC=com",
  "bindPassword": "service_password",
  "baseDn": "DC=example,DC=com",
  "userFilter": "(sAMAccountName={{username}})",
  "usernameAttribute": "sAMAccountName",
  "emailAttribute": "mail",
  "displayNameAttribute": "displayName",
  "groupBaseDn": "OU=Groups,DC=example,DC=com",
  "adminGroup": "CN=Dockhand Admins,OU=Groups,DC=example,DC=com",
  "tlsEnabled": false
}

With StartTLS

{
  "name": "Active Directory (StartTLS)",
  "serverUrl": "ldap://dc.example.com:389",
  "bindDn": "CN=Dockhand Service,OU=Service Accounts,DC=example,DC=com",
  "bindPassword": "service_password",
  "baseDn": "DC=example,DC=com",
  "userFilter": "(sAMAccountName={{username}})",
  "usernameAttribute": "sAMAccountName",
  "emailAttribute": "mail",
  "displayNameAttribute": "displayName",
  "tlsEnabled": true
}

LDAPS (LDAP over SSL)

{
  "name": "Active Directory (LDAPS)",
  "serverUrl": "ldaps://dc.example.com:636",
  "bindDn": "CN=Dockhand Service,OU=Service Accounts,DC=example,DC=com",
  "bindPassword": "service_password",
  "baseDn": "DC=example,DC=com",
  "userFilter": "(sAMAccountName={{username}})",
  "usernameAttribute": "sAMAccountName",
  "emailAttribute": "mail",
  "displayNameAttribute": "displayName",
  "tlsEnabled": true
}

{
  "name": "Active Directory (Email Login)",
  "serverUrl": "ldap://dc.example.com:389",
  "bindDn": "CN=Dockhand Service,OU=Service Accounts,DC=example,DC=com",
  "bindPassword": "service_password",
  "baseDn": "DC=example,DC=com",
  "userFilter": "(|(sAMAccountName={{username}})(mail={{username}}))",
  "usernameAttribute": "sAMAccountName",
  "emailAttribute": "mail",
  "displayNameAttribute": "displayName"
}

Users can log in with either alice or [email protected].

OpenLDAP Examples

Standard Configuration

{
  "name": "OpenLDAP",
  "serverUrl": "ldap://ldap.example.com:389",
  "bindDn": "cn=admin,dc=example,dc=com",
  "bindPassword": "admin_password",
  "baseDn": "ou=people,dc=example,dc=com",
  "userFilter": "(uid={{username}})",
  "usernameAttribute": "uid",
  "emailAttribute": "mail",
  "displayNameAttribute": "cn",
  "groupBaseDn": "ou=groups,dc=example,dc=com",
  "adminGroup": "cn=admins,ou=groups,dc=example,dc=com"
}

With posixGroup Schema

{
  "name": "OpenLDAP (posixGroup)",
  "serverUrl": "ldap://ldap.example.com:389",
  "bindDn": "cn=admin,dc=example,dc=com",
  "bindPassword": "admin_password",
  "baseDn": "ou=people,dc=example,dc=com",
  "userFilter": "(uid={{username}})",
  "usernameAttribute": "uid",
  "emailAttribute": "mail",
  "displayNameAttribute": "cn",
  "groupBaseDn": "ou=groups,dc=example,dc=com",
  "groupFilter": "(memberUid={{username}})",
  "adminGroup": "admins"
}

The posixGroup schema uses memberUid (username) instead of member (DN).

Admin Role Assignment

Automatically grant admin access based on LDAP group membership:

{
  "adminGroup": "CN=Dockhand Admins,OU=Groups,DC=example,DC=com"
}

Users in this group receive the Admin role in Dockhand.

Group DN vs. Group Name

You can specify either:

Full DN: CN=Dockhand Admins,OU=Groups,DC=example,DC=com (searches at that exact DN)
Group name: dockhand-admins (searches in groupBaseDn)

Dockhand detects which format you’re using based on the presence of = and ,.

Role Mappings

Map LDAP groups to Dockhand roles:

1. Create Roles

First, create roles in Dockhand (Settings > Roles):

Docker Admins (ID: 2) - Full access
Docker Viewers (ID: 3) - Read-only access
Dev Environment (ID: 4) - Access to dev environment only

2. Configure Role Mappings

Update LDAP config with role mappings:

curl -X PATCH http://localhost:8000/api/auth/ldap/1 \
  -H "Content-Type: application/json" \
  -H "Cookie: dockhand_session=YOUR_SESSION_TOKEN" \
  -d '{
    "groupBaseDn": "OU=Groups,DC=example,DC=com",
    "roleMappings": [
      {"groupDn": "CN=Docker Admins,OU=Groups,DC=example,DC=com", "roleId": 2},
      {"groupDn": "CN=Docker Viewers,OU=Groups,DC=example,DC=com", "roleId": 3},
      {"groupDn": "CN=Dev Team,OU=Groups,DC=example,DC=com", "roleId": 4}
    ]
  }'

How It Works

When a user logs in:

Dockhand checks membership in each mapped group
Assigns corresponding Dockhand roles
Removes roles for groups user is no longer in
Syncs roles on every login

This keeps Dockhand permissions in sync with your directory.

Security Features

LDAP Injection Prevention

Dockhand escapes special characters per RFC 4515:

function escapeLdapFilterValue(value: string): string {
  return value
    .replace(/\\/g, '\\5c')  // Backslash
    .replace(/\*/g, '\\2a')   // Asterisk (wildcard)
    .replace(/\(/g, '\\28')   // Left paren
    .replace(/\)/g, '\\29')   // Right paren
    .replace(/\0/g, '\\00');  // Null byte
}

This prevents attackers from injecting malicious LDAP filters.

Timing Attack Protection

Authentication failures use the same generic error message:

{"error": "Invalid username or password"}

Whether the user doesn’t exist or the password is wrong, the response is identical. This prevents username enumeration.

TLS Certificate Validation

When tlsEnabled: true and tlsCa is provided:

const client = new LdapClient({
  url: config.serverUrl,
  tlsOptions: {
    rejectUnauthorized: true,
    ca: [config.tlsCa]
  }
});

Dockhand validates the server certificate against the provided CA.

Troubleshooting

Connection Refused

Error: connect ECONNREFUSED Solutions:

Verify the LDAP server is reachable: telnet dc.example.com 389
Check firewall rules
Ensure Docker network allows outbound LDAP
Try IP address instead of hostname

Invalid Credentials (Service Account)

Error: InvalidCredentialsError Solutions:

Verify bindDn format matches your directory
Test bind with ldapsearch: ldapsearch -x -D "$BIND_DN" -W -b "$BASE_DN"
Check service account password
Ensure service account isn’t locked/expired

No Users Found

Error: Test returns userCount: 0 Solutions:

Verify baseDn contains users
Check userFilter matches your schema

Test search with ldapsearch:

ldapsearch -x -D "$BIND_DN" -W \
  -b "$BASE_DN" "(sAMAccountName=*)"

Authentication Failed (User)

Error: User gets “Invalid username or password” Solutions:

Verify user exists in LDAP
Check userFilter finds the user

Test bind as user:

ldapsearch -x -D "CN=Alice,OU=Users,DC=example,DC=com" -W \
  -b "DC=example,DC=com" "(objectClass=*)"

Ensure user account isn’t locked/disabled

Admin Role Not Assigned

Issue: User logs in but doesn’t have admin access. Solutions:

Verify adminGroup is configured
Check user is a member of the group
Verify groupBaseDn if using group name (not full DN)

Test group membership search:

ldapsearch -x -D "$BIND_DN" -W \
  -b "CN=Dockhand Admins,OU=Groups,DC=example,DC=com" \
  "(member=CN=Alice,OU=Users,DC=example,DC=com)"

TLS/SSL Errors

Error: unable to verify the first certificate Solutions:

Provide CA certificate in tlsCa field
Use full certificate chain if needed

Test TLS with openssl:

openssl s_client -connect dc.example.com:636 \
  -CAfile ca.crt -showcerts

Performance Tuning

Connection Pooling

Dockhand creates a new LDAP connection for each authentication. For high-traffic deployments, consider:

Read replica - Point serverUrl to a read-only domain controller
Load balancer - Distribute across multiple LDAP servers
Local caching - Use SSSD or nscd on the Docker host

Search Optimization

Narrow baseDn - Search only the OU containing users
Indexed attributes - Ensure sAMAccountName / uid is indexed
Limit group checks - Only map essential groups to roles

Source Code Reference

src/lib/server/auth.ts:488-757 - LDAP authentication logic
src/routes/api/auth/ldap/+server.ts - CRUD endpoints
src/routes/api/auth/ldap/[id]/test/+server.ts - Connection testing
src/lib/server/db/schema/pg-schema.ts:205-225 - Database schema

Next Steps

RBAC

Configure role-based access control

OIDC/SSO

Add SSO for non-LDAP users

Local Users

Manage fallback admin accounts

Two-Factor Auth

Add 2FA for local admin accounts

Overview

Getting Started

Core Features

Advanced Features

Authentication & Security

Deployment

Integrations

​Prerequisites

​Configuration

​1. Configure LDAP Provider

​Configuration Fields

​Testing Configuration

​Authentication Flow

​1. User Submits Credentials

​2. Search for User DN

​3. Bind as User

​4. Extract User Attributes

​5. Check Admin Group Membership

​6. Process Role Mappings

​7. Create/Update Local User

​8. Create Session

​Active Directory Examples

​Standard Configuration

​With StartTLS

​LDAPS (LDAP over SSL)

​Allow Email Login

​OpenLDAP Examples

​Standard Configuration

​With posixGroup Schema

​Admin Role Assignment

​Group DN vs. Group Name

​Role Mappings

​1. Create Roles

​2. Configure Role Mappings

​How It Works

​Security Features

​LDAP Injection Prevention

​Timing Attack Protection

​TLS Certificate Validation

​Troubleshooting

​Connection Refused

​Invalid Credentials (Service Account)

​No Users Found

​Authentication Failed (User)

​Admin Role Not Assigned

​TLS/SSL Errors

​Performance Tuning

​Connection Pooling

​Search Optimization

​Source Code Reference

​Next Steps

RBAC

OIDC/SSO

Local Users

Two-Factor Auth

Build docs developers (and LLMs) love

Prerequisites

Configuration

1. Configure LDAP Provider

Configuration Fields

Testing Configuration

Authentication Flow

1. User Submits Credentials

2. Search for User DN

3. Bind as User

4. Extract User Attributes

5. Check Admin Group Membership

6. Process Role Mappings

7. Create/Update Local User

8. Create Session

Active Directory Examples

Standard Configuration

With StartTLS

LDAPS (LDAP over SSL)

Allow Email Login

OpenLDAP Examples

Standard Configuration

With posixGroup Schema

Admin Role Assignment

Group DN vs. Group Name

Role Mappings

1. Create Roles

2. Configure Role Mappings

How It Works

Security Features

LDAP Injection Prevention

Timing Attack Protection

TLS Certificate Validation

Troubleshooting

Connection Refused

Invalid Credentials (Service Account)

No Users Found

Authentication Failed (User)

Admin Role Not Assigned

TLS/SSL Errors

Performance Tuning

Connection Pooling

Search Optimization

Source Code Reference

Next Steps