unseal

Documentation

Overview

Copyright The KubeVault Authors.

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.

Copyright The KubeVault Authors.

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

• type UnsealOptions
  • func NewUnsealOptions() *UnsealOptions
  • func (o *UnsealOptions) AddFlags(fs *pflag.FlagSet)
  • func (o *UnsealOptions) Apply() error
  • func (o *UnsealOptions) Validate() []error
• type Unsealer
  • func New(k kv.Service, cl *api.Client, config UnsealOptions) (Unsealer, error)

Types

type UnsealOptions

type UnsealOptions struct {
	KeyPrefix string

	// how many key parts exist
	SecretShares int
	// how many of these parts are needed to unseal vault  (secretThreshold <= secretShares)
	SecretThreshold int

	// should the root token be stored in the keyStore
	StoreRootToken bool

	// overwrite existing tokens
	OverwriteExisting bool
}

That configures the vault API

func NewUnsealOptions

func NewUnsealOptions() *UnsealOptions

func (*UnsealOptions) AddFlags

func (o *UnsealOptions) AddFlags(fs *pflag.FlagSet)

func (*UnsealOptions) Apply

func (o *UnsealOptions) Apply() error

func (*UnsealOptions) Validate

func (o *UnsealOptions) Validate() []error

type Unsealer

type Unsealer interface {
	IsSealed() (bool, error)
	IsInitialized() (bool, error)
	Unseal() error
	Init() error
	CheckReadWriteAccess() error
}

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

func New

func New(k kv.Service, cl *api.Client, config UnsealOptions) (Unsealer, error)

New returns a new Unsealer, or an error.