||2 weeks ago|
|.github||2 weeks ago|
|itest||2 weeks ago|
|scripts||3 years ago|
|src||9 months ago|
|.dockerignore||3 years ago|
|.gitignore||4 years ago|
|.pre-commit-config.yaml||1 year ago|
|Cargo.lock||2 weeks ago|
|Cargo.toml||2 weeks ago|
|Dockerfile||2 weeks ago|
|Dockerfile.alpine||2 weeks ago|
|LICENSE||4 years ago|
|Makefile||2 weeks ago|
|README.md||2 weeks ago|
|docker-compose.yml||2 weeks ago|
|example.config.toml||2 years ago|
An LDAP connector for vaultwarden
After configuring, run
vaultwarden_ldap and it will invite any users it finds in LDAP to your
This is easiest done using Docker. See the
docker-compose.yml file in this repo for an example. If you would like to use Docker Hub rather than building, change
build: . to
Make sure to populate and mount your
Configuration is read from a TOML file. The default location is
config.toml, but this can be configured by setting the
CONFIG_PATH env variable to whatever path you would like.
Configuration values are as follows:
||String||The root URL for accessing
||String||The value passed as
||String||Optional||Path to an additional der-encoded root certificate to trust. Eg.
||String||The hostname or IP address for your ldap server|
||String||Optional||The that should be used to connect.
||Boolean||Optional||Indicates if SSL should be used and if we should connect with
||Boolean||Optional||Indicates if the connection should be done using StartTLS|
||Boolean||Optional||Indicates if certificate should be verified when using SSL. Defaults to
||Integer||Optional||Port used to connect to the LDAP server. This will default to 389 or 636, depending on your SSL settings|
||String||The dn for the bind user that will connect to LDAP. Eg.
||String||The password for the provided bind user.|
||String||Base dn that will be used when searching LDAP for users. Eg.
||String||Filter used when searching LDAP for users. Eg.
||String||Optional||Field for each user record that contains the email address to use. Defaults to
||Integer||Optional||Number of seconds to wait between each LDAP request. Defaults to
||Boolean||Optional||Indicates whether or not syncing should be polled in a loop or done once. Defaults to
Alternatively, instead of using
config.toml, all values can be provided using enviroment variables prefixed with
APP_. For example:
This repo has a predefined set of pre-commit rules. You can install pre-commit via any means you'd like. Once your system has
pre-commit installed, you can run
make install-hooks to ensure the hooks will run with every commit. You can also force running all hooks with
For those less familiar with
cargo, you can use the
make targets that have been included for common tasks like running a debug version.
make run-debug or building a release version
There are no unit tests, but there are integration tests that require manual verification.
make itest will spin up an ldap server with a test user, a Vaultwarden server, and then run the sync. If successful the log should show an invitation sent to the test user. If you run
make itest again, it should show no invites sent because the user already has been invited. If you'd like to reset the testing,
make clean-itest will clear out the Vaultwarden database and start fresh.
It's also possible to test passing configs via enviornment variables by running
make itest-env. The validation steps are the same.
Steps for manual testing
The first step is to set up Bitwarden and the LDAP server.
docker-compose up -d vaultwarden ldap ldap_admin
After that, open the admin portal on http://localhost:8001 and log in using the default account info:
Username: cn=admin,dc=example,dc=org Password: admin
From there you can set up your test group and users.
dc=example,dc=orgnav tree and select "Create new entry here"
Select "Generic: Posix Group"
Give it a name, eg. "Users" and then save and commit
Select "Create child object"
Select "Generic: User Account"
Give the user a name and select a group ID number and save and commit
Select "Add new attribute" and select "Email" and then add a test email address
Run the ldap sync
docker-compose up ldap_sync
Alternately, you can bootstrap some of this by running:
docker-compose -f docker-compose.yml -f itest/docker-compose.itest.yml up --build