A tool for syncing a directory (AD, LDAP, Azure, G Suite, Okta) to an organization.

bitwarden typescript angular electron directory active-directory ldap okta gsuite azure-ad

Micaiah Martin d82f4d90c1 Added version bump workflow (#182 )		4 years ago
.github	Added version bump workflow (#182 )	4 years ago
.vscode	Lock lowdb file (#95 )	5 years ago
jslib@2db9e1ce0d	Update electron to 14.2.0 (#174 )	4 years ago
resources	disable-library-validation entitlement	6 years ago
scripts	Update pipeline to new model (#159 )	4 years ago
src	Add Azure Identity Authority Selector (#176 )	4 years ago
src-cli	Version bump to 2.9.5 (#148 )	4 years ago
.editorconfig	settings configuration	8 years ago
.gitattributes	stub out projects for the solution	9 years ago
.gitignore	notarize directory connector	6 years ago
.gitmodules	stub out electron app	8 years ago
CONTRIBUTING.md	stub out directory services	8 years ago
ISSUE_TEMPLATE.md	stub out directory services	8 years ago
LICENSE.txt	stub out directory services	8 years ago
README.md	Add node version to requirements in README.md (#117 )	5 years ago
SECURITY.md	Uppercase Bitwarden	8 years ago
package-lock.json	Update electron to 14.2.0 (#174 )	4 years ago
package.json	Remove empty catch blocks and remove allow-empty-catch tslint rule (#170 )	4 years ago
tsconfig.json	Add jslib as a "real" dependency (#127 )	5 years ago
tslint.json	Remove empty catch blocks and remove allow-empty-catch tslint rule (#170 )	4 years ago
webpack.cli.js	Add jslib as a "real" dependency (#127 )	5 years ago
webpack.main.js	Add jslib as a "real" dependency (#127 )	5 years ago
webpack.renderer.js	Add jslib as a "real" dependency (#127 )	5 years ago

README.md

Bitwarden Directory Connector

The Bitwarden Directory Connector is a a desktop application used to sync your Bitwarden enterprise organization to an existing directory of users and groups.

Supported directories:

Active Directory
Any other LDAP-based directory
Azure Active Directory
G Suite (Google)
Okta

The application is written using Electron with Angular and installs on Windows, macOS, and Linux distributions.

Command-line Interface

A command-line interface tool is also available for the Bitwarden Directory Connector. The Directory Connector CLI (bwdc) is written with TypeScript and Node.js and can also be run on Windows, macOS, and Linux distributions.

CLI Documentation

The Bitwarden Directory Connector CLI is self-documented with --help content and examples for every command. You should start exploring the CLI by using the global --help option:

bwdc --help

This option will list all available commands that you can use with the Directory Connector CLI.

Additionally, you can run the --help option on a specific command to learn more about it:

bwdc test --help
bwdc config --help

Detailed Documentation

We provide detailed documentation and examples for using the Directory Connector CLI in our help center at https://help.bitwarden.com/article/directory-sync/#command-line-interface.

Build/Run

Requirements

Node.js v14
Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer (recommended) or by installing windows-build-tools through npm. See more at Compiling native Addon modules.

Run the app

npm install
npm run reset # Only necessary if you have previously run the CLI app
npm run rebuild
npm run electron

Run the CLI

npm install
npm run reset # Only necessary if you have previously run the desktop app
npm run build:cli:watch

You can then run commands from the ./build-cli folder:

node ./build-cli/bwdc.js --help

Contribute

Code contributions are welcome! Please commit any pull requests against the master branch. Learn more about how to contribute by reading the CONTRIBUTING.md file.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file.