This repository houses the Bitwarden Secret Manager SDK. The SDK is written in Rust and provides a Rust API, CLI and various language bindings.

Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our Careers page to see what opportunities are currently open as well as what it's like to work at Bitwarden.

cargo build

To build, you will need the following in your PATH:

• Python
• Clang
  • We recommend installing this via the Visual Studio Build Tools

Please refer to our Contributing Docs for getting started instructions and architectural documentation.

You can also browse the latest published documentation on docs.rs.

The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates are:

• bitwarden: Rust friendly API for interacting with the secrets manager.
• bitwarden-c: C bindings for FFI interop.
• bitwarden-json: JSON wrapper around the bitwarden crate. Powers the other language bindings.
• bitwarden-napi: Node-API bindings.
• bws: CLI for interacting with the Bitwarden Secrets Manager. Review the CLI documentation.
• sdk-schemas: Generator for the json schemas.

To minimize the amount of work required to support additional bindings the project is structured around a json based API. With every binding only needing to implement one method, namely run_command.

To ensure type safety in the API, json schemas are generated from the rust structs in bitwarden using schemars. The json schemas are later used to generate the API bindings for each language using QuickType.

npm run schemas

This project recommends the use of certain developer tools, and also includes configurations for them to make developers lives easier. The use of these tools is optional and they might require a separate installation step.

The list of developer tools is:

• Visual Studio Code: We provide a recommended extension list which should show under the Extensions tab when opening this project with the editor. We also offer a few launch settings and tasks to build and run the SDK
• bacon: This is a CLI background code checker. We provide a configuration file with some of the most common tasks to run (check, clippy, test, doc - run bacon -l to see them all). This tool needs to be installed separately by running cargo install bacon --locked.
• nexttest: This is a new and faster test runner, capable of running tests in parallel and with a much nicer output compared to cargo test. This tool needs to be installed separately by running cargo install cargo-nextest --locked. It can be manually run using cargo nextest run --all-features

We use certain unstable features for formatting which require the nightly version of cargo-fmt.

To install:

rustup component add rustfmt --toolchain nightly

To run:

cargo +nightly fmt

Code contributions are welcome! Please commit any pull requests against the main branch. Learn more about how to contribute by reading the Contributing Guidelines. Check out the Contributing Documentation for how to get started with your first contribution.

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. We also run a program on HackerOne.

No grant of any rights in the trademarks, service marks, or logos of Bitwarden is made (except as may be necessary to comply with the notice requirements as applicable), and use of any Bitwarden trademarks must comply with Bitwarden Trademark Guidelines.