3c08c90dd3
These tests currently require some manual setup to be able to run in acceptance test (rather than unit test) mode, so this comment just captures those steps so we can find them more easily in future. Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
OpenTofu State and Plan encryption
Warning
This file is not an end-user documentation, it is intended for developers. Please follow the user documentation on the OpenTofu website unless you want to work on the encryption code.
This folder contains the code for state and plan encryption. For a quick example on how to use this package, please take a look at the example_test.go file.
Structure
The current folder contains the top level API. It requires a registry for holding the available key providers and encryption methods, which is located in the registry folder. The key providers are located in the keyprovider folder, while the encryption methods are located in the method folder. You can also find the configuration struct and its related functions in the config folder.
Further reading
For a detailed design document on state encryption, please read this document.