vault

Documentation

Overview

Copyright © 2022 Banzai Cloud

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func XORBase64(a, b string) ([]byte, error)
• func XORBytes(a, b []byte) ([]byte, error)
• type Config
• type KVService
• type Vault
  • func New(k KVService, cl *api.Client, config Config) (Vault, error)

Constants

const DefaultConfigFile = "vault-config.yml"

DefaultConfigFile is the name of the default config file

Functions

func XORBase64

func XORBase64(a, b string) ([]byte, error)

XORBase64 takes two base64-encoded strings and XORs the decoded byte slices together, returning the final byte slice. It is an error to pass in two strings that do not have the same length to their base64-decoded byte slice.

func XORBytes

func XORBytes(a, b []byte) ([]byte, error)

XORBytes takes two byte slices and XORs them together, returning the final byte slice. It is an error to pass in two byte slices that do not have the same length.

Types

type Config

type Config struct {
	// how many key parts exist
	SecretShares int
	// how many of these parts are needed to unseal Vault (secretThreshold <= secretShares)
	SecretThreshold int

	// if this root token is set, the dynamic generated will be invalidated and this created instead
	InitRootToken string
	// should the root token be stored in the keyStore
	StoreRootToken bool

	// should the KV backend be tested first to validate access rights
	PreFlightChecks bool
}

Config holds the configuration of the Vault initialization

type KVService

type KVService interface {
	Set(key string, value []byte) error
	Get(key string) ([]byte, error)
}

type Vault

type Vault interface {
	Init() error
	RaftInitialized() (bool, error)
	RaftJoin(string) error
	Sealed() (bool, error)
	Active() (bool, error)
	Unseal() error
	Leader() (bool, error)
	LeaderAddress() (string, error)
	Configure(config *viper.Viper) error
}

Vault is an interface that can be used to attempt to perform actions against a Vault server.

func New

func New(k KVService, cl *api.Client, config Config) (Vault, error)

New returns a new vault Vault, or an error.