vividboarder/bitwarden_rs_ldap
1
0
Fork 0
mirror of https://github.com/ViViDboarder/bitwarden_rs_ldap.git synced 2024-11-01 01:06:27 +00:00
Code Issues Releases Wiki Activity
LDAP directory connector for bitwarden_rs
97 Commits 2 Branches 19 Tags 1.7 MiB
Rust 84.5%
Makefile 10.3%
Dockerfile 3.7%
Shell 1.5%
a9f689b8cb
Go to file
dependabot[bot] a9f689b8cb
Bump serde_json from 1.0.73 to 1.0.79 
Bumps [serde_json](https://github.com/serde-rs/json) from 1.0.73 to 1.0.79.
- [Release notes](https://github.com/serde-rs/json/releases)
- [Commits](https://github.com/serde-rs/json/compare/v1.0.73...v1.0.79)

---
updated-dependencies:
- dependency-name: serde_json
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-01 04:06:57 +00:00
.github Fix hadolint in github actions 2022-01-20 12:46:32 -08:00
itest Make running integration tests easier 2021-07-23 15:28:19 -07:00
scripts Add linting, formatting and other checks 2020-07-09 12:09:19 -07:00
src Update reqwest usage for new version 2021-12-10 16:32:54 -08:00
.dockerignore Add linting, formatting and other checks 2020-07-09 12:09:19 -07:00
.gitignore Add Cargo.lock since this is an executable 2019-03-30 20:02:29 -07:00
.pre-commit-config.yaml Update pre-commit hooks 2022-01-20 12:32:10 -08:00
Cargo.lock Bump serde_json from 1.0.73 to 1.0.79 2022-03-01 04:06:57 +00:00
Cargo.toml Bump cargo versions in prep for release 2022-01-20 12:46:32 -08:00
docker-compose.yml Slim final image 2021-06-21 13:38:36 -07:00
Dockerfile Ignore consecutive run statement in hadolint 2021-11-29 10:47:33 -08:00
Dockerfile.alpine Update ca-certs for alpine 2022-01-20 12:52:59 -08:00
example.config.toml Rebrand vaultwarden 2021-05-07 12:55:29 -07:00
LICENSE Initial commit 2019-02-27 21:55:25 -08:00
Makefile Make running integration tests easier 2021-07-23 15:28:19 -07:00
README.md Update Readme to describe how to configure using env variables 2021-07-23 15:33:43 -07:00

README.md

vaultwarden_ldap

An LDAP connector for vaultwarden

After configuring, run vaultwarden_ldap and it will invite any users it finds in LDAP to your vaultwarden instance.

Deploying

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 image: vividboarder/vaultwarden_ldap.

Make sure to populate and mount your config.toml!

Configuration

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:

Name Type Optional Description
vaultwarden_url String The root URL for accessing vaultwarden. Eg: https://vw.example.com
vaultwarden_admin_token String The value passed as ADMIN_TOKEN to vaultwarden
vaultwarden_root_cert_file String Optional Path to an additional der-encoded root certificate to trust. Eg. root.cert. If using Docker see docker-compose.yml for how to expose it. Defaults to empty
ldap_host String The hostname or IP address for your ldap server
ldap_scheme String Optional The that should be used to connect. ldap or ldaps. This is set by default based on SSL settings
ldap_ssl Boolean Optional Indicates if SSL should be used and if we should connect with ldaps. Defaults to false
ldap_starttls Boolean Optional Indicates if the connection should be done using StartTLS
ldap_no_tls_verify Boolean Optional Indicates if certificate should be verified when using SSL. Defaults to true
ldap_port Integer Optional Port used to connect to the LDAP server. This will default to 389 or 636, depending on your SSL settings
ldap_bind_dn String The dn for the bind user that will connect to LDAP. Eg. cn=admin,dc=example,dc=org
ldap_bind_password String The password for the provided bind user.
ldap_search_base_dn String Base dn that will be used when searching LDAP for users. Eg. dc=example,dc=org
ldap_search_filter String Filter used when searching LDAP for users. Eg. (&(objectClass=*)(uid=*))
ldap_mail_field String Optional Field for each user record that contains the email address to use. Defaults to mail
ldap_sync_interval_seconds Integer Optional Number of seconds to wait between each LDAP request. Defaults to 60
ldap_sync_loop Boolean Optional Indicates whether or not syncing should be polled in a loop or done once. Defaults to true

Alternatively, instead of using config.toml, all values can be provided using enviroment variables prefixed with APP_. For example: APP_VAULTWARDEN_URL=https://vault.example.com

Development

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 make check.

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 make release.

Testing

All testing is manual right now. First step is to set up Bitwarden and the LDAP server.

docker-compose up -d vaultwarden ldap ldap_admin

  1. 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.

  1. Expand the dc=example,dc=org nav tree and select "Create new entry here"

  2. Select "Generic: Posix Group"

  3. Give it a name, eg. "Users" and then save and commit

  4. Select "Create child object"

  5. Select "Generic: User Account"

  6. Give the user a name and select a group ID number and save and commit

  7. Select "Add new attribute" and select "Email" and then add a test email address

  8. 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

Future

  • Any kind of proper logging
  • Tests