Terraform Provider for Bitwarden

A provider for Terraform/OpenTofu to manage Bitwarden Password Manager and Secrets Manager resource. This project is not associated with the Bitwarden project nor Bitwarden, Inc.

Explore the docs »

---

Table of Contents

• Supported Versions
• Usage
• Embedded Client
• Security Considerations
• Developing the Provider
• License

Supported Versions

The plugin has been tested and built with the following components:

• Terraform v1.9.8 / OpenTofu v1.8.0
• Bitwarden CLI v2023.2.0 (when not using the Embedded Client)
• Go 1.23.1 (for development)
• Docker 24.0.6 (for development)

The provider is likely to work with older versions, but those haven't been tested. If you encounter issues with recent versions of the Bitwarden CLI, consider trying out the Embedded Client.

Usage

The complete documentation for this provider can be found on the Terraform Registry docs.

terraform {
  required_providers {
    bitwarden = {
      source  = "maxlaverse/bitwarden"
      version = ">= 0.12.1"
    }
  }
}

# Configure the Bitwarden Provider
provider "bitwarden" {
  email = "[email protected]"

  # Specify a server url when using a self-hosted version of Bitwarden
  # or similar (e.g. Vaultwarden).
  #
  # server = "https://vault.myserver.org"

  # If you have the opportunity, you can try out the embedded client which
  # removes the need for a locally installed Bitwarden CLI. Please note that
  # this feature is still considered experimental and not recommended for
  # production use yet.
  #
  # experimental {
  #   embedded_client = true
  # }
}

# Create a Bitwarden Login item
resource "bitwarden_item_login" "example" {
  name     = "Example"
  username = "service-account"
  password = "<sensitive>"
}

# or use an existing Bitwarden resource
data "bitwarden_item_login" "example" {
  search = "Example"
}

See the examples directory for more examples.

Embedded Client

Since version 0.9.0, the provider contains an embedded client that can directly interact with Bitwarden's API, removing the need for a locally installed Bitwarden CLI. The embedded client makes the provider faster, easier to use, but it still requires more testing. For now, a feature flag needs to be set in order to use it (experimental.embedded_client), with the goal of having it the default in v1.0.0.

Security Considerations

When not using the Embedded Client, the provider downloads the encrypted Vault locally during plan or apply operations as would the Bitwarden CLI if you used it directly. Currently, the Terraform SDK doesn't offer a way to remove the encrypted Vault once changes have been applied. The issue hashicorp/terraform-plugin-sdk#63 tracks discussions for adding such a feature.

If you want find out more about this file, you can read Terraform's documentation on Data Storage. Please note that this file is stored at <your-project>/.bitwarden/ by default, in order to not interfere with your local Vaults.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, start a Vaultwarden server:

$ make server

Then run make testacc.

$ make testacc

License

Distributed under the Mozilla License. See LICENSE for more information.