https://github.com/bitwarden/sdk-internal
Bitwarden internal SDK.
https://github.com/bitwarden/sdk-internal
bitwarden rust sdk
Last synced: 6 months ago
JSON representation
Bitwarden internal SDK.
- Host: GitHub
- URL: https://github.com/bitwarden/sdk-internal
- Owner: bitwarden
- License: other
- Created: 2024-10-21T16:20:25.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T10:12:39.000Z (6 months ago)
- Last Synced: 2025-04-05T11:23:00.736Z (6 months ago)
- Topics: bitwarden, rust, sdk
- Language: Rust
- Homepage:
- Size: 4.86 MB
- Stars: 69
- Watchers: 14
- Forks: 9
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: support/build-api.sh
Awesome Lists containing this project
README
# Bitwarden Internal SDK
This repository houses the internal Bitwarden SDKs. We also provide a public
[Secrets Manager SDK](https://github.com/bitwarden/sdk-sm).
### Disclaimer
The password manager SDK is not intended for public use and is not supported by Bitwarden at this
stage. It is solely intended to centralize the business logic and to provide a single source of
truth for the internal applications. As the SDK evolves into a more stable and feature complete
state we will re-evaluate the possibility of publishing stable bindings for the public. **The
password manager interface is unstable and will change without warning.**
# We're Hiring!
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](https://bitwarden.com/careers/) to see what opportunities
are currently open as well as what it's like to work at Bitwarden.
## Getting Started
### Linux / Mac / Windows
```bash
cargo build
```
### Windows on ARM
To build, you will need the following in your PATH:
- [Python](https://www.python.org)
- [Clang](https://clang.llvm.org)
- We recommend installing this via the
[Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)
## Documentation
Please refer to our [Contributing Docs](https://contributing.bitwarden.com/) for
[getting started](https://contributing.bitwarden.com/getting-started/sdk/) instructions and
[architectural documentation](https://contributing.bitwarden.com/architecture/sdk/).
You can also browse the latest published documentation:
- [docs.rs](https://docs.rs/bitwarden/latest/bitwarden/) for the public SDK.
- Or for developers of the SDK, view the internal
[API documentation](https://sdk-api-docs.bitwarden.com/bitwarden_core/index.html) which includes
private items.
## Crates
The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates
are:
- [`bitwarden-api-api`](./crates/bitwarden-api-api/): Auto-generated API bindings for the API
server.
- [`bitwarden-api-identity`](./crates/bitwarden-api-identity/): Auto-generated API bindings for the
Identity server.
- [`bitwarden-core`](./crates/bitwarden-core/): The core functionality consumed by the other crates.
- [`bitwarden-crypto`](./crates/bitwarden-crypto/): Crypto library.
- [`bitwarden-wasm-internal`](./crates/bitwarden-wasm-internal/): WASM bindings for the internal
SDK.
- [`bitwarden-uniffi`](./crates/bitwarden-uniffi/): Mobile bindings for swift and kotlin using
[UniFFI](https://github.com/mozilla/uniffi-rs/).
## API Bindings
We autogenerate the server bindings using
[openapi-generator](https://github.com/OpenAPITools/openapi-generator). To do this we first need to
build the internal swagger documentation.
### Swagger generation
The first step is to generate the swagger documents from the server repository.
```bash
# src/Api
dotnet swagger tofile --output ../../api.json ./bin/Debug/net8.0/Api.dll internal
# src/Identity
ASPNETCORE_ENVIRONMENT=development dotnet swagger tofile --output ../../identity.json ./bin/Debug/net8.0/Identity.dll v1
```
### OpenApi Generator
To generate a new version of the bindings run the following script from the root of the SDK project.
```bash
./support/build-api.sh
```
This project uses customized templates which lives in the `support/openapi-templates` directory.
These templates resolves some outstanding issues we've experienced with the rust generator. But we
strive towards modifying the templates as little as possible to ease future upgrades.
### Note
- If you don't have the nightly toolchain installed, the `build-api.sh` script will install it for
you.
- This process also changes the `Cargo.toml` file. When creating a PR updating the bindings, please
revert (do not include) the updates to the `Cargo.toml` file.
## Developer tools
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`
## Formatting & Linting
This repository uses various tools to check formatting and linting before it's merged. It's
recommended to run the checks prior to submitting a PR.
### Installation
Please see the [lint.yml](./.github/workflows/lint.yml) file for example installation commands &
versions. Here are the cli tools we use:
- Nightly [cargo fmt](https://github.com/rust-lang/rustfmt) and
[cargo udeps](https://github.com/est31/cargo-udeps)
- [rust clippy](https://github.com/rust-lang/rust-clippy)
- [cargo sort](https://github.com/DevinR528/cargo-sort)
- [prettier](https://github.com/prettier/prettier)
### Checks
To verify if changes need to be made, here are examples for the above tools:
```
export RUSTFLAGS="-D warnings"
cargo +nightly fmt --check
cargo +nightly udeps --workspace --all-features
cargo clippy --all-features --tests
cargo sort --workspace --check
npm run lint
```
## Contribute
Code contributions are welcome! Please commit any pull requests against the `main` branch. Learn
more about how to contribute by reading the
[Contributing Guidelines](https://contributing.bitwarden.com/contributing/). Check out the
[Contributing Documentation](https://contributing.bitwarden.com/) 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`](SECURITY.md) file.
We also run a program on [HackerOne](https://hackerone.com/bitwarden).
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](https://github.com/bitwarden/server/blob/main/TRADEMARK_GUIDELINES.md).