Configuration Identity Stores

Configuration Identity Stores

Purpose

Use this skill to configure local identity store <name> and ldap identity store <name> blocks. The dispatcher is caddyfile_identity.go; the store parser is caddyfile_identity_store.go.

Use configuration-users for detailed local user <username> entries. Check github.com/greenpau/go-authcrunch/pkg/ids when changing this skill: ids.Config.Validate admits only local and ldap stores and validates the authcrunch parameter names produced by the Caddyfile parser.

Local Stores

Local stores require realm and path in the authcrunch config. The full Caddyfile form is:

security {
	local identity store localdb {
		realm local
		path assets/config/users.json
	}
}

The local shortcut is valid and sets realm local plus the user file path. Only local stores support this shortcut:

local identity store localdb assets/config/users.json

Add users inline only when the Caddyfile should own the local account data:

user alice {
	name "Alice Example"
	email alice@example.com
	password {env.ALICE_PASSWORD} overwrite
	roles authp/user authp/admin
}

Local store-level options supported by authcrunch are login_icon, username_recovery_enabled, password_recovery_enabled, contact_support_enabled, support_link, and support_email. In Caddyfile, set those with icon, enable username recovery, enable password recovery, enable contact support, support link, and support email.

When a local database path does not exist, authcrunch can create the database and bootstrap an administrative user. For first-run support, inspect Caddy logs for the generated username, email, and password. These environment variables can override the bootstrap account:

AUTHP_ADMIN_USER
AUTHP_ADMIN_EMAIL
AUTHP_ADMIN_SECRET

The local database stores password and username policy fields. The default password policy requires length 8-128, and the default username policy requires length 3-50. Users with non-guest portal access can change their password from the portal profile/settings UI; administrators can also update hashes with authdbctl or by editing the local database carefully.

LDAP Stores

LDAP stores require realm and servers at config-validation time. At provisioning time authcrunch also needs bind credentials, search_base_dn, and either explicit groups or automatic group mapping. Use this practical shape:

ldap identity store corp {
	realm corp.example.com
	servers {
		ldaps://ldap.example.com ignore_cert_errors
	}
	username "CN=authsvc,OU=Service Accounts,DC=example,DC=com"
	password {env.LDAP_BIND_PASSWORD}
	search_base_dn "DC=example,DC=com"
	search_filter "(&(|(sAMAccountName=%s)(mail=%s))(objectclass=user))"
	attributes {
		name givenName
		surname sn
		username sAMAccountName
		member_of memberOf
		email mail
	}
	groups {
		"CN=Admins,OU=Groups,DC=example,DC=com" authp/admin
		"CN=Users,OU=Groups,DC=example,DC=com" authp/user
	}
}

Use these Caddyfile-to-authcrunch aliases deliberately:

• username becomes bind_username; do not write bind_username in Caddyfile.
• password becomes bind_password; if omitted, authcrunch falls back to LDAP_USER_SECRET during provisioning.
• search_filter is a legacy alias for search_user_filter; prefer search_user_filter for clarity when adding new examples.
• trusted_authority <path> appends to authcrunch trusted_authorities.
• icon becomes login_icon.

LDAP server addresses must start with ldap:// or ldaps://. Authcrunch uses default ports 389 and 636, or a port in the URL, and defaults timeout to 5 seconds; the Caddyfile parser currently exposes only ignore_cert_errors and posix_groups server flags.

Prefer trusted_authority <path> for LDAPS trust over ignore_cert_errors. When collecting a server certificate chain for trust configuration, use openssl s_client -showcerts against the LDAPS endpoint, split the PEM certificates, and point trusted_authority at the required CA files.

If search_user_filter, search_group_filter, or attributes are omitted, authcrunch defaults to Active Directory-style values: sAMAccountName/mail, memberOf, givenName, sn, and (&(uniqueMember=%s)(objectClass=groupOfUniqueNames)). Override them for POSIX or non-AD directories.

Group mapping rules:

• Use groups { <group_dn> <role> [<role>...] } for explicit LDAP DN to role mappings.
• Use enable short automatic group mapping to map group DNs to the lower-case first RDN value, such as ou=mathematicians,... to mathematicians.
• Use enable full automatic group mapping to map group DNs to lower-case full DN roles.
• Add posix_groups on a server when group membership must be found through search_group_filter instead of the user's member_of attribute.
• Authcrunch supports fallback_roles for roles assigned when the user authenticates but no LDAP group mapping produced roles. It does not replace the requirement for explicit or automatic group mapping to configure LDAP.
• Do not add new Caddyfile fallback-role examples until caddyfile_identity_store.go is fixed and tested: the current parser stores args[2:], so ordinary fallback role authp/user drops the first role.

Runtime LDAP authentication flow:

1. Authcrunch opens a fresh LDAP connection for the login attempt; it does not keep long-lived LDAP connections open.
2. It binds with the configured service username and password.
3. It substitutes the submitted username/email into search_user_filter and searches under search_base_dn.
4. Authentication fails unless exactly one user object is found.
5. It maps LDAP group DNs to roles from explicit or automatic group mapping. If no role is produced and no supported fallback applies, authentication fails before token issuance.
6. It re-binds as the found user DN with the submitted password. A successful re-bind allows token issuance.

This flow means a correct-looking Caddyfile can still fail because the search filter is too broad, group membership does not map to any role, LDAPS trust is missing, or service bind credentials are wrong.

Store Options

Supported store-level options include:

• disabled
• realm, path, search_base_dn, search_group_filter, search_user_filter, search_filter, username, and password
• trusted_authority <path>
• attributes { <local_name> <remote_name> }
• servers { <ldap_url> [ignore_cert_errors] [posix_groups] }
• groups { <group_dn> <role> [<role>...] }
• enable username recovery, enable password recovery, enable contact support
• enable full automatic group mapping and enable short automatic group mapping
• support link <url> and support email <address>
• icon <text> ...

Do not invent raw authcrunch JSON field names as Caddyfile directives unless the parser accepts them. In particular, Caddyfile uses username, password, trusted_authority, and search_filter/search_user_filter, while the adapted authcrunch config stores bind_username, bind_password, trusted_authorities, and search_user_filter.

Portal Wiring

After defining a store, enable it from an authentication portal:

authentication portal myportal {
	enable identity store localdb corp
}

Fixtures

Use these examples:

• caddyfile_identity_test.go.
• caddyfile_identity_store_test.go.
• testdata/caddyfile_adapt/testcase_security_authentication_portal.Caddyfile.