xor

README

XOR-based dual-custody key provider

This key provider combines two keys to create a dual-custody encryption key using XOR. This provider is meant for testing purposes only.

[!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.

Configuration

You can configure the key provider as follows. Note, the input keys must have the same length.

terraform {
    encryption {
        key_provider "pbkdf2" "a" {
            passphrase = "This is passphrase 1"
        }
        key_provider "pbkdf2" "b" {
            passphrase = "This is passphrase 2"
        }
        key_provider "xor" "myprovider" {
            a = key_provider.pbkdf2.a
            b = key_provider.pbkdf2.b
        }
    }
}

Documentation

Overview

Package xor contains a key provider that combines two other keys.

Index

• type Config
  • func (c Config) Build() (keyprovider.KeyProvider, keyprovider.KeyMeta, error)
• type Descriptor
  • func New() Descriptor

Types

type Config

type Config struct {
	A keyprovider.Output `hcl:"a"`
	B keyprovider.Output `hcl:"b"`
}

Config contains the configuration for this key provider supplied by the user. This struct must have hcl tags in order to function.

func (Config) Build

func (c Config) Build() (keyprovider.KeyProvider, keyprovider.KeyMeta, error)

Build will create the usable key provider.

type Descriptor

type Descriptor interface {
	keyprovider.Descriptor
}

Descriptor is an additional interface to allow for providing custom methods.

func New

func New() Descriptor