mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-22 11:17:35 -05:00
60fdd359d5
Signed-off-by: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com>
37 lines
1.3 KiB
Go
37 lines
1.3 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package external
|
|
|
|
import (
|
|
"github.com/opentofu/opentofu/internal/encryption/keyprovider"
|
|
)
|
|
|
|
// TODO #2386 / 1.11: consider if the external method changes and unify protocol with the external key provider.
|
|
|
|
// HeaderMagic is the magic string that needs to be present in the header to identify
|
|
// the external program as an external keyprovider for OpenTofu.
|
|
const HeaderMagic = "OpenTofu-External-Key-Provider"
|
|
|
|
// Header describes the initial header the external program must output as a single line,
|
|
// followed by a single newline.
|
|
type Header struct {
|
|
// Magic must always be "OpenTofu-External-Key-Provider".
|
|
Magic string `json:"magic"`
|
|
// Version is the protocol version number. This currently must be 1.
|
|
Version int `json:"version"`
|
|
}
|
|
|
|
// InputV1 describes the input datastructure passed in over stdin.
|
|
// This structure is valid for protocol version 1.
|
|
type InputV1 *MetadataV1
|
|
|
|
// OutputV1 describes the output datastructure written to stdout by the external program.
|
|
// This structure is valid for protocol version 1.
|
|
type OutputV1 struct {
|
|
Keys keyprovider.Output `json:"keys"`
|
|
Meta MetadataV1 `json:"meta,omitempty"`
|
|
}
|