2 unstable releases
|0.2.1||Mar 22, 2023|
|0.1.0||Mar 20, 2023|
#1 in #secrets-manager
Bitwarden Secrets Manager SDK
This repository houses the Bitwarden Secrets Manager SDK. The core SDK is written in Rust and provides a Rust API, CLI and Node-API bindings. In the future more language bindings might be added.
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.
The project is structured as a monorepo using cargo workspaces.
bitwarden: Rust friendly API for interacting with the secrets manager.
bitwarden-api-api: Auto-generated API bindings for the API server.
bitwarden-api-identity: Auto-generated API bindings for the Identity server.
bitwarden-c: C bindings for FFI interop.
bitwarden-json: JSON wrapper around the
bitwardencrate. Powers the other language bindings.
bitwarden-napi: Node-API bindings.
bws: CLI for interacting with the secrets manager.
sdk-schemas: Generator for the json schemas.
To minimize the amount of work required to support additional bindings the project is structured
json based API. With every binding only needing to implement one method, namely
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
npm run schemas
We autogenerate the server bindings using openapi-generator. To do this we first need to build the internal swagger documentation.
The first step is to generate the swagger documents from the server repository.
# src/Api dotnet swagger tofile --output ../../api.json .\bin\Debug\net6.0\Api.dll internal # src/Identity dotnet swagger tofile --output ../../identity.json .\bin\Debug\net6.0\Identity.dll v1
Runs from the root of the SDK project.
npx openapi-generator-cli generate ` -i ../server/api.json ` -g rust ` -o crates/bitwarden-api-api ` --package-name bitwarden-api-api ` -t ./support/openapi-template ` --additional-properties=packageVersion=1.0.0 npx openapi-generator-cli generate ` -i ../server/identity.json ` -g rust ` -o crates/bitwarden-api-identity ` --package-name bitwarden-api-identity ` -t ./support/openapi-template ` --additional-properties=packageVersion=1.0.0
OpenApi Generator works using templates, we have customized our templates to work better with our codebase.
There is also a scenario where we have a negative integer enum which completely breaks the openapi
generation. In that case we excluded the file from being generated and manually patched it.
The hope going forward is that we can continue to use the generator with minimal manual intervention.