Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxlaverse/terraform-provider-bitwarden
Terraform Bitwarden provider to read, create, or update logins, secure notes, folders, org-collections in your Bitwarden Vaults
https://github.com/maxlaverse/terraform-provider-bitwarden
bitwarden opentofu opentofu-provider terraform terraform-provider vaultwarden
Last synced: 6 days ago
JSON representation
Terraform Bitwarden provider to read, create, or update logins, secure notes, folders, org-collections in your Bitwarden Vaults
- Host: GitHub
- URL: https://github.com/maxlaverse/terraform-provider-bitwarden
- Owner: maxlaverse
- License: mpl-2.0
- Created: 2022-01-16T22:13:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T06:51:28.000Z (19 days ago)
- Last Synced: 2024-10-19T08:11:05.141Z (18 days ago)
- Topics: bitwarden, opentofu, opentofu-provider, terraform, terraform-provider, vaultwarden
- Language: Go
- Homepage: https://registry.terraform.io/providers/maxlaverse/bitwarden
- Size: 678 KB
- Stars: 63
- Watchers: 3
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Terraform Provider for Bitwarden
[](https://coveralls.io/github/maxlaverse/terraform-provider-bitwarden?branch=main)
The Terraform Bitwarden provider is a plugin for Terraform that allows to manage different kind of Bitwarden resources from their [Password Manager] and [Secrets Manager] products.
This project is not associated with the Bitwarden project nor 8bit Solutions LLC.
**[Explore the docs »][Terraform Registry docs]**
---
## Table of Contents
- [Supported Versions](#supported-versions)
- [Usage](#usage)
- [Developing the Provider](#developing-the-provider)
- [License](#license)
## Supported Versions
The plugin has been tested and built with the following components:
- [Terraform] v1.6.1 / [OpenTofu] v1.8.0
- [Bitwarden CLI] v2023.2.0 (if not using the experimental `embedded_client`)
- [Go] 1.23.1 (for development)
- [Docker] 23.0.5 (for development)
The provider likely works with older versions but those haven't been tested.
## Usage
The complete documentation for this provider can be found on the [Terraform Registry docs].
```tf
terraform {
required_providers {
bitwarden = {
source = "maxlaverse/bitwarden"
version = ">= 0.10.0"
}
}
}
# Configure the Bitwarden Provider
provider "bitwarden" {
email = "[email protected]"
# 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
# as experimental, might not work as expected, and is not recommended for production use.
#
# experimental {
# embedded_client = true
# }
}
# Create a Bitwarden Login item
resource "bitwarden_item_login" "example" {
name = "Example"
username = "service-account"
password = ""
}
# or use an existing Bitwarden resource
data "bitwarden_item_login" "example" {
search = "Example"
}
```
See the [examples](./examples/) directory for more examples.
## Security Considerations
The Terraform Bitwarden provider entirely relies on the [Bitwarden CLI] to interact with Vaults.
When you ask Terraform to *plan* or *apply* changes, the provider downloads the encrypted Vault locally as if you would use the Bitwarden CLI 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 `/.bitwarden/` by default, in order to not interfere with your local Vaults.
NOTE: This whole paragraph doesn't apply to the experimental client, as nothing is stored on disk.
## Developing the Provider
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#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:
```sh
$ make server
```
Then run `make testacc`.
```sh
$ make testacc
```
## License
Distributed under the Mozilla License. See [LICENSE](./LICENSE) for more information.
[Terraform]: https://www.terraform.io/downloads.html
[OpenTofu]: https://opentofu.org/
[Go]: https://golang.org/doc/install
[Bitwarden CLI]: https://bitwarden.com/help/article/cli/#download-and-install
[Docker]: https://www.docker.com/products/docker-desktop
[Terraform Registry docs]: https://registry.terraform.io/providers/maxlaverse/bitwarden/latest/docs
[hashicorp/terraform-plugin-sdk#63]: https://github.com/hashicorp/terraform-plugin-sdk/issues/63
[Terraform's documentation on Data Storage]: https://bitwarden.com/help/data-storage/#on-your-local-machine
[Password Manager]: https://bitwarden.com/products/personal/
[Secrets Manager]: https://bitwarden.com/products/secrets-manager/