From 85e163967cf5b58bc4ea01b34a4325cd1b2ed94c Mon Sep 17 00:00:00 2001 From: unkin-agent Date: Mon, 16 Nov 2026 23:14:30 +1100 Subject: [PATCH 1/5] Move module to github.com/IUCLabs and use the iuclabs/gpgvaultsecret address --- go.mod | 2 +- main.go | 6 ++++-- scripts/e2e.sh | 2 +- test/e2e/main.tf | 4 ++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/go.mod b/go.mod index 75c822a..fb04013 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module git.unkin.net/unkin/terraform-provider-gpgvaultsecret +module github.com/IUCLabs/terraform-provider-gpgvaultsecret go 1.25 diff --git a/main.go b/main.go index 04af2b5..5269a69 100644 --- a/main.go +++ b/main.go @@ -7,9 +7,11 @@ import ( "github.com/hashicorp/terraform-plugin-framework/providerserver" - "git.unkin.net/unkin/terraform-provider-gpgvaultsecret/internal/provider" + "github.com/IUCLabs/terraform-provider-gpgvaultsecret/internal/provider" ) +//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@v0.25.0 generate --provider-name gpg --rendered-provider-name gpgvaultsecret + var version = "0.0.1" func main() { @@ -18,7 +20,7 @@ func main() { flag.Parse() opts := providerserver.ServeOpts{ - Address: "git.unkin.net/unkin/gpgvaultsecret", + Address: "registry.terraform.io/iuclabs/gpgvaultsecret", Debug: debug, } diff --git a/scripts/e2e.sh b/scripts/e2e.sh index c48706a..190c473 100755 --- a/scripts/e2e.sh +++ b/scripts/e2e.sh @@ -54,7 +54,7 @@ green "vault ready" cat > "${WORK}/dev.tfrc" < Date: Mon, 16 Nov 2026 23:14:30 +1100 Subject: [PATCH 2/5] Add MIT license, rewrite README and generate registry docs with tfplugindocs --- LICENSE | 21 +++++ Makefile | 9 +- README.md | 92 +++++++------------ docs/data-sources/key.md | 44 +++++++++ docs/index.md | 48 ++++++++++ docs/resources/key.md | 60 ++++++++++++ docs/resources/secret_backend.md | 57 ++++++++++++ examples/data-sources/gpg_key/data-source.tf | 8 ++ examples/data-sources/gpg_key/main.tf | 9 -- examples/provider/provider.tf | 22 +++++ examples/resources/gpg_key/import.sh | 2 + examples/resources/gpg_key/main.tf | 15 --- examples/resources/gpg_key/resource.tf | 10 ++ .../resources/gpg_secret_backend/import.sh | 2 + examples/resources/gpg_secret_backend/main.tf | 9 -- .../resources/gpg_secret_backend/resource.tf | 16 ++++ internal/provider/datasource_key.go | 2 +- internal/provider/provider.go | 5 +- internal/provider/resource_key.go | 14 +-- internal/provider/resource_secret_backend.go | 4 +- 20 files changed, 342 insertions(+), 107 deletions(-) create mode 100644 LICENSE create mode 100644 docs/data-sources/key.md create mode 100644 docs/index.md create mode 100644 docs/resources/key.md create mode 100644 docs/resources/secret_backend.md create mode 100644 examples/data-sources/gpg_key/data-source.tf delete mode 100644 examples/data-sources/gpg_key/main.tf create mode 100644 examples/provider/provider.tf create mode 100644 examples/resources/gpg_key/import.sh delete mode 100644 examples/resources/gpg_key/main.tf create mode 100644 examples/resources/gpg_key/resource.tf create mode 100644 examples/resources/gpg_secret_backend/import.sh delete mode 100644 examples/resources/gpg_secret_backend/main.tf create mode 100644 examples/resources/gpg_secret_backend/resource.tf diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..83ee371 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 IUCLabs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile index 344029a..78b6c25 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,10 @@ -.PHONY: build install test lint fmt clean tidy package e2e patch minor major check-go +.PHONY: build install test lint fmt clean tidy package e2e docs patch minor major check-go BINARY := terraform-provider-gpgvaultsecret VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo "0.0.0-dev") OS_ARCH := linux_amd64 INSTALL_VERSION := $(shell echo $(VERSION) | sed 's/^v//') -INSTALL_DIR := ~/.terraform.d/plugins/git.unkin.net/unkin/gpgvaultsecret/$(INSTALL_VERSION)/$(OS_ARCH) +INSTALL_DIR := ~/.terraform.d/plugins/registry.terraform.io/iuclabs/gpgvaultsecret/$(INSTALL_VERSION)/$(OS_ARCH) ZIP := $(BINARY)_$(INSTALL_VERSION)_$(OS_ARCH).zip GO_VERSION_REQUIRED := 1.25 @@ -31,12 +31,15 @@ lint: check-go fmt: check-go gofmt -w . +docs: + go generate ./... + package: build cp $(BINARY) $(BINARY)_v$(INSTALL_VERSION) python3 -c "import zipfile,sys; z=zipfile.ZipFile(sys.argv[1],'w',zipfile.ZIP_DEFLATED); z.write(sys.argv[2]); z.close()" $(ZIP) $(BINARY)_v$(INSTALL_VERSION) rm $(BINARY)_v$(INSTALL_VERSION) -# End-to-end: boots Vault + LiteLLM + the plugin and applies real terraform. +# End-to-end: boots Vault + the gpg plugin and applies real terraform. e2e: ./scripts/e2e.sh diff --git a/README.md b/README.md index 2e727f6..b3850ca 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,68 @@ -# terraform-provider-gpgvaultsecret +# Terraform Provider for vault-plugin-secrets-gpg -A Terraform/OpenTofu provider for the -[vault-plugin-secrets-gpg](https://git.unkin.net/unkin/vault-plugin-secrets-gpg) -engine. It manages the engine **mount** (and, optionally, plugin catalog -registration) and **OpenPGP keys** on HashiCorp Vault or OpenBao. +This provider manages the +[vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) +secrets engine on HashiCorp Vault or OpenBao, with Terraform or OpenTofu. Use +it to mount the engine (and, optionally, register the plugin in the catalog), +and to create OpenPGP keys whose private material stays inside Vault. -The provider's source address is `git.unkin.net/unkin/gpgvaultsecret`; its -resources are prefixed `gpg_` (declare it under the local name `gpg`). +Resources use the `gpg_` prefix, so declare the provider under the local name +`gpg`. -## Resources & data sources - -| Type | Purpose | -|------|---------| -| `gpg_secret_backend` (resource) | Mount the gpg engine at a path. When `sha256` is set, register the plugin in the catalog first. | -| `gpg_key` (resource) | Create and configure an OpenPGP key (algorithm, identity, exportable, deletion, min decryption version); exposes the armored public key, fingerprint, key id and latest version. | -| `gpg_key` (data source) | Read an existing key's metadata + armored public key. | - -## Usage +## Quick Start ```hcl terraform { required_providers { gpg = { - source = "artifactapi.k8s.syd1.au.unkin.net/terraform-unkin/gpgvaultsecret" + source = "IUCLabs/gpgvaultsecret" } } } +# address and token fall back to VAULT_ADDR and VAULT_TOKEN. provider "gpg" { - # address and token fall back to VAULT_ADDR / VAULT_TOKEN - address = "https://vault.main.unkin.net" + address = "https://vault.example.com:8200" } -# Mount the engine. Omit sha256 if the plugin is already registered out of band -# (e.g. by terraform-vault). Set it to have this resource register the plugin. resource "gpg_secret_backend" "gpg" { - path = "gpg" - description = "GPG/OpenPGP secrets engine" - # sha256 = "0e92d7408795688badb55789bc1604e8f1dd4d71998656c7f831991fce9a7b20" + path = "gpg" } resource "gpg_key" "app" { backend = gpg_secret_backend.gpg.path name = "app" - algorithm = "rsa-4096" # rsa-2048 | rsa-3072 | rsa-4096 | ed25519 - identity = "App " + algorithm = "rsa-4096" + identity = "App " } -# Wire the armored public key somewhere (e.g. a pass store, a k8s secret). output "app_public_key" { value = gpg_key.app.public_key } ``` -### `gpg_secret_backend` +## Requirements -| Attribute | | Description | -|-----------|-----|-------------| -| `path` | required, force-new | Mount path (e.g. `gpg`). | -| `plugin` | optional, force-new | Registered plugin name/mount type. Default `vault-plugin-secrets-gpg`. | -| `description` | optional | Mount description. | -| `sha256` | optional | If set, (re)register the plugin in the catalog with this binary hash before mounting. | -| `command` | optional | Binary filename in the server `plugin_directory` used for registration. Defaults to `plugin`. | +- [Terraform](https://developer.hashicorp.com/terraform/downloads) 1.0+ or [OpenTofu](https://opentofu.org/) +- HashiCorp Vault 1.12+ or OpenBao 2.x, with the + [vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) + binary in the server's `plugin_directory` +- [Go](https://go.dev/doc/install) 1.25+ (only if you build from source) -Import: `terraform import gpg_secret_backend.gpg gpg`. +## Usage -### `gpg_key` +See the [docs](docs/index.md) for the provider, `gpg_secret_backend`, +`gpg_key` and the `gpg_key` data source. -| Attribute | | Description | -|-----------|-----|-------------| -| `backend` | required, force-new | Mount path of the engine. | -| `name` | required, force-new | Key name. | -| `algorithm` | optional, force-new | `rsa-2048` / `rsa-3072` (default) / `rsa-4096` / `ed25519`. | -| `identity` | optional, force-new | OpenPGP User ID. Defaults to the key name. | -| `exportable` | optional | Allow private-key export (enable-only). | -| `deletion_allowed` | optional | Whether the key may be deleted. `terraform destroy` enables this automatically. | -| `min_decryption_version` | optional | Minimum version usable for decrypt/verify. | -| `latest_version`, `fingerprint`, `key_id`, `public_key` | computed | Current key material metadata. | - -Import: `terraform import gpg_key.app gpg/app`. - -## Build +## Development ```sh -make build # -> terraform-provider-gpgvaultsecret -make install # into ~/.terraform.d/plugins/... for local use -make test # go test -race (unit tests; no Vault needed) -make e2e # real terraform apply/destroy against a Vault dev server + the gpg plugin -make package # zip for the artifactapi terraform registry +make build # build the provider binary +make test # unit tests +make docs # regenerate docs/ from the schema and examples/ +make e2e # apply real Terraform against a Vault dev server ``` -CI (Woodpecker) runs pre-commit/build/lint/test on PRs. On a `v*` tag it builds -and PUTs `terraform-provider-gpgvaultsecret__linux_amd64.zip` to the -artifactapi `terraform-unkin` registry (GPG-signed server-side), installable via -the bare `source = "artifactapi.k8s.syd1.au.unkin.net/terraform-unkin/gpgvaultsecret"`. +## License + +[MIT](LICENSE) diff --git a/docs/data-sources/key.md b/docs/data-sources/key.md new file mode 100644 index 0000000..0273270 --- /dev/null +++ b/docs/data-sources/key.md @@ -0,0 +1,44 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gpg_key Data Source - gpgvaultsecret" +subcategory: "" +description: |- + Reads an OpenPGP key's metadata and armored public key from a gpg secrets engine mount. +--- + +# gpg_key (Data Source) + +Reads an OpenPGP key's metadata and armored public key from a gpg secrets engine mount. + +## Example Usage + +```terraform +data "gpg_key" "app" { + backend = "gpg" + name = "app" +} + +output "app_fingerprint" { + value = data.gpg_key.app.fingerprint +} +``` + + +## Schema + +### Required + +- `backend` (String) Mount path of the gpg secrets engine. +- `name` (String) Name of the key. + +### Read-Only + +- `algorithm` (String) Key algorithm. +- `deletion_allowed` (Boolean) Whether the key may be deleted. +- `exportable` (Boolean) Whether the private key is exportable. +- `fingerprint` (String) OpenPGP fingerprint of the latest version. +- `identity` (String) OpenPGP User ID. +- `key_id` (String) OpenPGP key ID of the latest version. +- `latest_version` (Number) Current (highest) key version. +- `min_decryption_version` (Number) Minimum key version usable for decryption. +- `public_key` (String) Armored public key of the latest version. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..625a77a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,48 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gpgvaultsecret Provider" +description: |- + Manage the vault-plugin-secrets-gpg https://github.com/IUCLabs/vault-plugin-secrets-gpg secrets engine (mounts and OpenPGP keys) on HashiCorp Vault or OpenBao. + Resources and data sources use the gpg_ prefix, so declare the provider under the local name gpg in required_providers. +--- + +# gpgvaultsecret Provider + +Manage the [vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) secrets engine (mounts and OpenPGP keys) on HashiCorp Vault or OpenBao. + +Resources and data sources use the `gpg_` prefix, so declare the provider under the local name `gpg` in `required_providers`. + +## Example Usage + +```terraform +terraform { + required_providers { + gpg = { + source = "IUCLabs/gpgvaultsecret" + } + } +} + +# address and token fall back to VAULT_ADDR and VAULT_TOKEN. +provider "gpg" { + address = "https://vault.example.com:8200" +} + +resource "gpg_secret_backend" "gpg" { + path = "gpg" +} + +resource "gpg_key" "app" { + backend = gpg_secret_backend.gpg.path + name = "app" + identity = "App " +} +``` + + +## Schema + +### Optional + +- `address` (String) Address of the Vault/OpenBao server. Falls back to the VAULT_ADDR environment variable. +- `token` (String, Sensitive) Token used to authenticate to Vault/OpenBao. Falls back to the VAULT_TOKEN environment variable. diff --git a/docs/resources/key.md b/docs/resources/key.md new file mode 100644 index 0000000..eb2b330 --- /dev/null +++ b/docs/resources/key.md @@ -0,0 +1,60 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gpg_key Resource - gpgvaultsecret" +subcategory: "" +description: |- + Manages an OpenPGP key in a gpg secrets engine mount. +--- + +# gpg_key (Resource) + +Manages an OpenPGP key in a gpg secrets engine mount. + +## Example Usage + +```terraform +resource "gpg_key" "app" { + backend = "gpg" + name = "app" + algorithm = "rsa-4096" + identity = "App " +} + +output "app_public_key" { + value = gpg_key.app.public_key +} +``` + + +## Schema + +### Required + +- `backend` (String) Mount path of the gpg secrets engine (e.g. "gpg"). Changing this forces a new key. +- `name` (String) Name of the key. Changing this forces a new key. + +### Optional + +- `algorithm` (String) Key algorithm: rsa-2048, rsa-3072, rsa-4096 or ed25519. Defaults to rsa-3072. Changing this forces a new key. +- `deletion_allowed` (Boolean) Whether the key may be deleted. Terraform enables this automatically on destroy. Defaults to false. +- `exportable` (Boolean) Allow exporting the private key. Can be enabled later but never disabled. Defaults to false. +- `identity` (String) OpenPGP User ID (e.g. "Jane Doe "). Defaults to the key name. Changing this forces a new key. +- `min_decryption_version` (Number) Minimum key version usable for decryption. Defaults to 1. + +### Read-Only + +- `fingerprint` (String) OpenPGP fingerprint of the latest version. +- `key_id` (String) OpenPGP key ID of the latest version. +- `latest_version` (Number) The current (highest) key version. +- `public_key` (String) Armored public key of the latest version (import into gpg/pass to encrypt to this key). + +## Import + +Import is supported using the following syntax: + +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + +```shell +# Import by /. +terraform import gpg_key.app gpg/app +``` diff --git a/docs/resources/secret_backend.md b/docs/resources/secret_backend.md new file mode 100644 index 0000000..42f46f8 --- /dev/null +++ b/docs/resources/secret_backend.md @@ -0,0 +1,57 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gpg_secret_backend Resource - gpgvaultsecret" +subcategory: "" +description: |- + Mounts the gpg secrets engine. Optionally registers the plugin in the catalog first when a sha256 is given. +--- + +# gpg_secret_backend (Resource) + +Mounts the gpg secrets engine. Optionally registers the plugin in the catalog first when a sha256 is given. + +## Example Usage + +```terraform +# Mount a plugin that is already registered in the catalog. +resource "gpg_secret_backend" "gpg" { + path = "gpg" + description = "OpenPGP keys" +} + +# Register the binary in the server's plugin_directory, then mount it. +variable "plugin_sha256" { + type = string +} + +resource "gpg_secret_backend" "registered" { + path = "gpg-registered" + sha256 = var.plugin_sha256 + command = "vault-plugin-secrets-gpg" +} +``` + + +## Schema + +### Required + +- `path` (String) Mount path for the gpg secrets engine (e.g. "gpg"). Changing this forces a new mount. + +### Optional + +- `command` (String) Plugin binary filename (relative to the server plugin_directory) used when registering. Defaults to the plugin name. Only used when sha256 is set. +- `description` (String) Human-readable description of the mount. +- `plugin` (String) Registered plugin name (mount type). Defaults to vault-plugin-secrets-gpg. Changing this forces a new mount. +- `sha256` (String) SHA-256 of the plugin binary. When set, the plugin is (re)registered in the catalog before mounting; omit if the plugin is already registered out of band. + +## Import + +Import is supported using the following syntax: + +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + +```shell +# Import by mount path. +terraform import gpg_secret_backend.gpg gpg +``` diff --git a/examples/data-sources/gpg_key/data-source.tf b/examples/data-sources/gpg_key/data-source.tf new file mode 100644 index 0000000..42a7303 --- /dev/null +++ b/examples/data-sources/gpg_key/data-source.tf @@ -0,0 +1,8 @@ +data "gpg_key" "app" { + backend = "gpg" + name = "app" +} + +output "app_fingerprint" { + value = data.gpg_key.app.fingerprint +} diff --git a/examples/data-sources/gpg_key/main.tf b/examples/data-sources/gpg_key/main.tf deleted file mode 100644 index e68b584..0000000 --- a/examples/data-sources/gpg_key/main.tf +++ /dev/null @@ -1,9 +0,0 @@ -data "gpg_key" "app" { - backend = "gpg" - name = "app" -} - -# e.g. import into a pass store or hand to another system -output "app_public_key" { - value = data.gpg_key.app.public_key -} diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf new file mode 100644 index 0000000..1faf778 --- /dev/null +++ b/examples/provider/provider.tf @@ -0,0 +1,22 @@ +terraform { + required_providers { + gpg = { + source = "IUCLabs/gpgvaultsecret" + } + } +} + +# address and token fall back to VAULT_ADDR and VAULT_TOKEN. +provider "gpg" { + address = "https://vault.example.com:8200" +} + +resource "gpg_secret_backend" "gpg" { + path = "gpg" +} + +resource "gpg_key" "app" { + backend = gpg_secret_backend.gpg.path + name = "app" + identity = "App " +} diff --git a/examples/resources/gpg_key/import.sh b/examples/resources/gpg_key/import.sh new file mode 100644 index 0000000..380809d --- /dev/null +++ b/examples/resources/gpg_key/import.sh @@ -0,0 +1,2 @@ +# Import by /. +terraform import gpg_key.app gpg/app diff --git a/examples/resources/gpg_key/main.tf b/examples/resources/gpg_key/main.tf deleted file mode 100644 index 0a392f4..0000000 --- a/examples/resources/gpg_key/main.tf +++ /dev/null @@ -1,15 +0,0 @@ -resource "gpg_key" "app" { - backend = "gpg" - name = "app" - algorithm = "rsa-4096" # rsa-2048 | rsa-3072 | rsa-4096 | ed25519 - identity = "App " - exportable = false -} - -output "app_public_key" { - value = gpg_key.app.public_key -} - -output "app_fingerprint" { - value = gpg_key.app.fingerprint -} diff --git a/examples/resources/gpg_key/resource.tf b/examples/resources/gpg_key/resource.tf new file mode 100644 index 0000000..338d8d3 --- /dev/null +++ b/examples/resources/gpg_key/resource.tf @@ -0,0 +1,10 @@ +resource "gpg_key" "app" { + backend = "gpg" + name = "app" + algorithm = "rsa-4096" + identity = "App " +} + +output "app_public_key" { + value = gpg_key.app.public_key +} diff --git a/examples/resources/gpg_secret_backend/import.sh b/examples/resources/gpg_secret_backend/import.sh new file mode 100644 index 0000000..a960ec9 --- /dev/null +++ b/examples/resources/gpg_secret_backend/import.sh @@ -0,0 +1,2 @@ +# Import by mount path. +terraform import gpg_secret_backend.gpg gpg diff --git a/examples/resources/gpg_secret_backend/main.tf b/examples/resources/gpg_secret_backend/main.tf deleted file mode 100644 index 3982182..0000000 --- a/examples/resources/gpg_secret_backend/main.tf +++ /dev/null @@ -1,9 +0,0 @@ -resource "gpg_secret_backend" "gpg" { - path = "gpg" - description = "GPG/OpenPGP secrets engine" - - # Optional: have this resource register the plugin in the catalog. Omit if the - # plugin is already registered (e.g. by terraform-vault). - # sha256 = "0e92d7408795688badb55789bc1604e8f1dd4d71998656c7f831991fce9a7b20" - # command = "vault-plugin-secrets-gpg" -} diff --git a/examples/resources/gpg_secret_backend/resource.tf b/examples/resources/gpg_secret_backend/resource.tf new file mode 100644 index 0000000..1683a55 --- /dev/null +++ b/examples/resources/gpg_secret_backend/resource.tf @@ -0,0 +1,16 @@ +# Mount a plugin that is already registered in the catalog. +resource "gpg_secret_backend" "gpg" { + path = "gpg" + description = "OpenPGP keys" +} + +# Register the binary in the server's plugin_directory, then mount it. +variable "plugin_sha256" { + type = string +} + +resource "gpg_secret_backend" "registered" { + path = "gpg-registered" + sha256 = var.plugin_sha256 + command = "vault-plugin-secrets-gpg" +} diff --git a/internal/provider/datasource_key.go b/internal/provider/datasource_key.go index 789e665..e030818 100644 --- a/internal/provider/datasource_key.go +++ b/internal/provider/datasource_key.go @@ -54,7 +54,7 @@ func (d *keyDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, re "identity": schema.StringAttribute{Description: "OpenPGP User ID.", Computed: true}, "exportable": schema.BoolAttribute{Description: "Whether the private key is exportable.", Computed: true}, "deletion_allowed": schema.BoolAttribute{Description: "Whether the key may be deleted.", Computed: true}, - "min_decryption_version": schema.Int64Attribute{Description: "Minimum usable version for decryption/verification.", Computed: true}, + "min_decryption_version": schema.Int64Attribute{Description: "Minimum key version usable for decryption.", Computed: true}, "latest_version": schema.Int64Attribute{Description: "Current (highest) key version.", Computed: true}, "fingerprint": schema.StringAttribute{Description: "OpenPGP fingerprint of the latest version.", Computed: true}, "key_id": schema.StringAttribute{Description: "OpenPGP key ID of the latest version.", Computed: true}, diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 68a6ad6..59a3323 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -29,7 +29,7 @@ func New(version string) func() provider.Provider { } func (p *gpgProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) { - // The provider's source address is git.unkin.net/unkin/gpgvaultsecret, but + // The provider's source address is iuclabs/gpgvaultsecret, but // its resources are prefixed "gpg_" (declare it in required_providers under // the local name "gpg"), mirroring how google-beta ships google_*. resp.TypeName = "gpg" @@ -39,6 +39,9 @@ func (p *gpgProvider) Metadata(_ context.Context, _ provider.MetadataRequest, re func (p *gpgProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) { resp.Schema = schema.Schema{ Description: "Manage the vault-plugin-secrets-gpg engine — mounts and OpenPGP keys — on HashiCorp Vault or OpenBao.", + MarkdownDescription: "Manage the [vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) " + + "secrets engine (mounts and OpenPGP keys) on HashiCorp Vault or OpenBao.\n\n" + + "Resources and data sources use the `gpg_` prefix, so declare the provider under the local name `gpg` in `required_providers`.", Attributes: map[string]schema.Attribute{ "address": schema.StringAttribute{ Description: "Address of the Vault/OpenBao server. Falls back to the VAULT_ADDR environment variable.", diff --git a/internal/provider/resource_key.go b/internal/provider/resource_key.go index d0eb3b3..4160c24 100644 --- a/internal/provider/resource_key.go +++ b/internal/provider/resource_key.go @@ -54,42 +54,42 @@ func (r *keyResource) Schema(_ context.Context, _ resource.SchemaRequest, resp * Description: "Manages an OpenPGP key in a gpg secrets engine mount.", Attributes: map[string]schema.Attribute{ "backend": schema.StringAttribute{ - Description: "Mount path of the gpg secrets engine (e.g. \"gpg\").", + Description: "Mount path of the gpg secrets engine (e.g. \"gpg\"). Changing this forces a new key.", Required: true, PlanModifiers: requiresReplace, }, "name": schema.StringAttribute{ - Description: "Name of the key.", + Description: "Name of the key. Changing this forces a new key.", Required: true, PlanModifiers: requiresReplace, }, "algorithm": schema.StringAttribute{ - Description: "Key algorithm: rsa-2048, rsa-3072, rsa-4096 or ed25519.", + Description: "Key algorithm: rsa-2048, rsa-3072, rsa-4096 or ed25519. Defaults to rsa-3072. Changing this forces a new key.", Optional: true, Computed: true, Default: stringdefault.StaticString("rsa-3072"), PlanModifiers: requiresReplace, }, "identity": schema.StringAttribute{ - Description: "OpenPGP User ID (e.g. \"Me \"). Defaults to the key name.", + Description: "OpenPGP User ID (e.g. \"Jane Doe \"). Defaults to the key name. Changing this forces a new key.", Optional: true, Computed: true, PlanModifiers: requiresReplace, }, "exportable": schema.BoolAttribute{ - Description: "Allow exporting the private key. Can be enabled later but never disabled.", + Description: "Allow exporting the private key. Can be enabled later but never disabled. Defaults to false.", Optional: true, Computed: true, Default: booldefault.StaticBool(false), }, "deletion_allowed": schema.BoolAttribute{ - Description: "Whether the key may be deleted. Terraform enables this automatically on destroy.", + Description: "Whether the key may be deleted. Terraform enables this automatically on destroy. Defaults to false.", Optional: true, Computed: true, Default: booldefault.StaticBool(false), }, "min_decryption_version": schema.Int64Attribute{ - Description: "Minimum key version usable for decryption and verification.", + Description: "Minimum key version usable for decryption. Defaults to 1.", Optional: true, Computed: true, }, diff --git a/internal/provider/resource_secret_backend.go b/internal/provider/resource_secret_backend.go index fee7c2d..e7964fa 100644 --- a/internal/provider/resource_secret_backend.go +++ b/internal/provider/resource_secret_backend.go @@ -46,14 +46,14 @@ func (r *secretBackendResource) Schema(_ context.Context, _ resource.SchemaReque Description: "Mounts the gpg secrets engine. Optionally registers the plugin in the catalog first when a sha256 is given.", Attributes: map[string]schema.Attribute{ "path": schema.StringAttribute{ - Description: "Mount path for the gpg secrets engine (e.g. \"gpg\").", + Description: "Mount path for the gpg secrets engine (e.g. \"gpg\"). Changing this forces a new mount.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), }, }, "plugin": schema.StringAttribute{ - Description: "Registered plugin name/type to mount.", + Description: "Registered plugin name (mount type). Defaults to vault-plugin-secrets-gpg. Changing this forces a new mount.", Optional: true, Computed: true, Default: stringdefault.StaticString(defaultPluginType), -- 2.47.3 From 24f26d38cf688d7b9501f9bf53de9ece4a25aa81 Mon Sep 17 00:00:00 2001 From: unkin-agent Date: Mon, 16 Nov 2026 23:18:32 +1100 Subject: [PATCH 3/5] Document min_decryption_version range, drop untested version claim --- README.md | 5 +++-- docs/resources/key.md | 2 +- internal/provider/resource_key.go | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b3850ca..a9e0806 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,10 @@ output "app_public_key" { ## Requirements - [Terraform](https://developer.hashicorp.com/terraform/downloads) 1.0+ or [OpenTofu](https://opentofu.org/) -- HashiCorp Vault 1.12+ or OpenBao 2.x, with the +- HashiCorp Vault or OpenBao, with the [vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) - binary in the server's `plugin_directory` + binary in the server's `plugin_directory` (see that repo for the server + versions it is tested against) - [Go](https://go.dev/doc/install) 1.25+ (only if you build from source) ## Usage diff --git a/docs/resources/key.md b/docs/resources/key.md index eb2b330..d4e5c5e 100644 --- a/docs/resources/key.md +++ b/docs/resources/key.md @@ -39,7 +39,7 @@ output "app_public_key" { - `deletion_allowed` (Boolean) Whether the key may be deleted. Terraform enables this automatically on destroy. Defaults to false. - `exportable` (Boolean) Allow exporting the private key. Can be enabled later but never disabled. Defaults to false. - `identity` (String) OpenPGP User ID (e.g. "Jane Doe "). Defaults to the key name. Changing this forces a new key. -- `min_decryption_version` (Number) Minimum key version usable for decryption. Defaults to 1. +- `min_decryption_version` (Number) Minimum key version usable for decryption. Must be between 1 and `latest_version`, otherwise the write fails. Defaults to 1. ### Read-Only diff --git a/internal/provider/resource_key.go b/internal/provider/resource_key.go index 4160c24..3678b12 100644 --- a/internal/provider/resource_key.go +++ b/internal/provider/resource_key.go @@ -89,7 +89,7 @@ func (r *keyResource) Schema(_ context.Context, _ resource.SchemaRequest, resp * Default: booldefault.StaticBool(false), }, "min_decryption_version": schema.Int64Attribute{ - Description: "Minimum key version usable for decryption. Defaults to 1.", + Description: "Minimum key version usable for decryption. Must be between 1 and `latest_version`, otherwise the write fails. Defaults to 1.", Optional: true, Computed: true, }, -- 2.47.3 From a86eb5f4ed98496bab99d0f8f785770fed82be2b Mon Sep 17 00:00:00 2001 From: unkin-agent Date: Tue, 17 Nov 2026 22:23:34 +1100 Subject: [PATCH 4/5] Rename provider to IUCLabs/vault-secrets-gpg --- .gitignore | 2 +- Makefile | 4 ++-- README.md | 6 +++--- docs/data-sources/key.md | 2 +- docs/index.md | 6 +++--- docs/resources/key.md | 2 +- docs/resources/secret_backend.md | 2 +- examples/provider/provider.tf | 2 +- go.mod | 2 +- internal/provider/provider.go | 2 +- main.go | 6 +++--- scripts/e2e.sh | 6 +++--- test/e2e/main.tf | 2 +- 13 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.gitignore b/.gitignore index 6bd339c..5111979 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -/terraform-provider-gpgvaultsecret +/terraform-provider-vault-secrets-gpg *.zip *.out *.test diff --git a/Makefile b/Makefile index 78b6c25..abc9645 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,10 @@ .PHONY: build install test lint fmt clean tidy package e2e docs patch minor major check-go -BINARY := terraform-provider-gpgvaultsecret +BINARY := terraform-provider-vault-secrets-gpg VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo "0.0.0-dev") OS_ARCH := linux_amd64 INSTALL_VERSION := $(shell echo $(VERSION) | sed 's/^v//') -INSTALL_DIR := ~/.terraform.d/plugins/registry.terraform.io/iuclabs/gpgvaultsecret/$(INSTALL_VERSION)/$(OS_ARCH) +INSTALL_DIR := ~/.terraform.d/plugins/registry.terraform.io/iuclabs/vault-secrets-gpg/$(INSTALL_VERSION)/$(OS_ARCH) ZIP := $(BINARY)_$(INSTALL_VERSION)_$(OS_ARCH).zip GO_VERSION_REQUIRED := 1.25 diff --git a/README.md b/README.md index a9e0806..9ae7ba1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ secrets engine on HashiCorp Vault or OpenBao, with Terraform or OpenTofu. Use it to mount the engine (and, optionally, register the plugin in the catalog), and to create OpenPGP keys whose private material stays inside Vault. -Resources use the `gpg_` prefix, so declare the provider under the local name -`gpg`. +The registry type is `vault-secrets-gpg`; its resources are prefixed `gpg_`, +so declare the provider under the local name `gpg`. ## Quick Start @@ -15,7 +15,7 @@ Resources use the `gpg_` prefix, so declare the provider under the local name terraform { required_providers { gpg = { - source = "IUCLabs/gpgvaultsecret" + source = "IUCLabs/vault-secrets-gpg" } } } diff --git a/docs/data-sources/key.md b/docs/data-sources/key.md index 0273270..08696a8 100644 --- a/docs/data-sources/key.md +++ b/docs/data-sources/key.md @@ -1,6 +1,6 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "gpg_key Data Source - gpgvaultsecret" +page_title: "gpg_key Data Source - gpg" subcategory: "" description: |- Reads an OpenPGP key's metadata and armored public key from a gpg secrets engine mount. diff --git a/docs/index.md b/docs/index.md index 625a77a..b1f606b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "gpgvaultsecret Provider" +page_title: "gpg Provider" description: |- Manage the vault-plugin-secrets-gpg https://github.com/IUCLabs/vault-plugin-secrets-gpg secrets engine (mounts and OpenPGP keys) on HashiCorp Vault or OpenBao. Resources and data sources use the gpg_ prefix, so declare the provider under the local name gpg in required_providers. --- -# gpgvaultsecret Provider +# gpg Provider Manage the [vault-plugin-secrets-gpg](https://github.com/IUCLabs/vault-plugin-secrets-gpg) secrets engine (mounts and OpenPGP keys) on HashiCorp Vault or OpenBao. @@ -18,7 +18,7 @@ Resources and data sources use the `gpg_` prefix, so declare the provider under terraform { required_providers { gpg = { - source = "IUCLabs/gpgvaultsecret" + source = "IUCLabs/vault-secrets-gpg" } } } diff --git a/docs/resources/key.md b/docs/resources/key.md index d4e5c5e..93c26cd 100644 --- a/docs/resources/key.md +++ b/docs/resources/key.md @@ -1,6 +1,6 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "gpg_key Resource - gpgvaultsecret" +page_title: "gpg_key Resource - gpg" subcategory: "" description: |- Manages an OpenPGP key in a gpg secrets engine mount. diff --git a/docs/resources/secret_backend.md b/docs/resources/secret_backend.md index 42f46f8..a9e55c6 100644 --- a/docs/resources/secret_backend.md +++ b/docs/resources/secret_backend.md @@ -1,6 +1,6 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "gpg_secret_backend Resource - gpgvaultsecret" +page_title: "gpg_secret_backend Resource - gpg" subcategory: "" description: |- Mounts the gpg secrets engine. Optionally registers the plugin in the catalog first when a sha256 is given. diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index 1faf778..ba7d116 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -1,7 +1,7 @@ terraform { required_providers { gpg = { - source = "IUCLabs/gpgvaultsecret" + source = "IUCLabs/vault-secrets-gpg" } } } diff --git a/go.mod b/go.mod index fb04013..1b48cd3 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/IUCLabs/terraform-provider-gpgvaultsecret +module github.com/IUCLabs/terraform-provider-vault-secrets-gpg go 1.25 diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 59a3323..575ef8a 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -29,7 +29,7 @@ func New(version string) func() provider.Provider { } func (p *gpgProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) { - // The provider's source address is iuclabs/gpgvaultsecret, but + // The provider's source address is IUCLabs/vault-secrets-gpg, but // its resources are prefixed "gpg_" (declare it in required_providers under // the local name "gpg"), mirroring how google-beta ships google_*. resp.TypeName = "gpg" diff --git a/main.go b/main.go index 5269a69..3c0b9c9 100644 --- a/main.go +++ b/main.go @@ -7,10 +7,10 @@ import ( "github.com/hashicorp/terraform-plugin-framework/providerserver" - "github.com/IUCLabs/terraform-provider-gpgvaultsecret/internal/provider" + "github.com/IUCLabs/terraform-provider-vault-secrets-gpg/internal/provider" ) -//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@v0.25.0 generate --provider-name gpg --rendered-provider-name gpgvaultsecret +//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@v0.24.0 generate --provider-name gpg var version = "0.0.1" @@ -20,7 +20,7 @@ func main() { flag.Parse() opts := providerserver.ServeOpts{ - Address: "registry.terraform.io/iuclabs/gpgvaultsecret", + Address: "registry.terraform.io/iuclabs/vault-secrets-gpg", Debug: debug, } diff --git a/scripts/e2e.sh b/scripts/e2e.sh index 190c473..17acdd2 100755 --- a/scripts/e2e.sh +++ b/scripts/e2e.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # -# End-to-end test for terraform-provider-gpgvaultsecret. Boots a Vault dev server +# End-to-end test for terraform-provider-vault-secrets-gpg. Boots a Vault dev server # running the vault-plugin-secrets-gpg engine, then applies real terraform that # registers + mounts the backend, creates a key, and reads it via the data # source. Verifies the outputs and that the mounted engine actually works, then @@ -37,7 +37,7 @@ trap cleanup EXIT blue "Building provider" make -C "${ROOT_DIR}" build >/dev/null -PROVIDER_BIN="${ROOT_DIR}/terraform-provider-gpgvaultsecret" +PROVIDER_BIN="${ROOT_DIR}/terraform-provider-vault-secrets-gpg" blue "Starting Vault dev server (plugin_directory=${PLUGIN_DIR})" vault server -dev -dev-root-token-id=root -dev-listen-address=127.0.0.1:8282 \ @@ -54,7 +54,7 @@ green "vault ready" cat > "${WORK}/dev.tfrc" < Date: Tue, 17 Nov 2026 22:38:25 +1100 Subject: [PATCH 5/5] Link the releases page in the README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9ae7ba1..7630c11 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ so declare the provider under the local name `gpg`. ## Quick Start +Prebuilt provider archives are on the [releases page](https://github.com/IUCLabs/terraform-provider-vault-secrets-gpg/releases). + ```hcl terraform { required_providers { -- 2.47.3