vault

Documentation

Index

• Constants
• Variables
• func CreateVault(kubeClient kubernetes.Interface, vaultOperatorClient versioned.Interface, ...) error
• func DeleteVault(vaultOperatorClient versioned.Interface, name string, ns string) error
• func FindVault(vaultOperatorClient versioned.Interface, name string, ns string) bool
• func GetAuthSaName(vault v1alpha1.Vault) string
• func GetVault(vaultOperatorClient versioned.Interface, name string, ns string) (*v1alpha1.Vault, error)
• func VaultGcpServiceAccountSecretName(vaultName string, clusterName string) string
• type GCPConfig
• type GCSConfig
• type JxVaulter
  • func (v *JxVaulter) Config() (vaultUrl url.URL, vaultToken string, err error)
  • func (v *JxVaulter) GetVaultClient() *api.Client
  • func (v *JxVaulter) Secrets() ([]string, error)
• type Listener
• type PathPolicy
• type PathRule
  • func (r *PathRule) String() (string, error)
• type Storage
• type Tcp
• type Telemetry
• type Vault
  • func GetVaults(client kubernetes.Interface, vaultOperatorClient versioned.Interface, ...) ([]*Vault, error)
• type VaultAuth
• type VaultAuths
• type VaultClientFactory
  • func NewInteractiveVaultClientFactory(options common.OptionsInterface) (VaultClientFactory, error)
  • func NewSystemVaultClientFactory(kubeClient kubernetes.Interface, vaultOperatorClient versioned.Interface, ...) (VaultClientFactory, error)
  • func (v *VaultClientFactory) GetConfigData(name string, namespace string) (config *api.Config, jwt string, saName string, err error)
  • func (v VaultClientFactory) NewVaultClient(name string, namespace string) (*api.Client, error)
• type VaultOptions
• type VaultPolicies
• type VaultPolicy
• type VaultRole
• type VaultSelector
  • func NewVaultSelector(o common.OptionsInterface) (VaultSelector, error)
• type Vaulter
  • func NewVaulter(o VaultOptions) (Vaulter, error)

Constants

const (
	DenyCapability   = "deny"
	CreateCapability = "create"
	ReadCapability   = "read"
	UpdateCapability = "update"
	DeleteCapability = "delete"
	ListCapability   = "list"
	SudoCapability   = "sudo"
	RootCapability   = "root"

	PathRulesName            = "allow_secrets"
	DefaultSecretsPathPrefix = "secret/*"
	PoliciesName             = "policies"
)

const (
	SystemVaultName = "jx-vault"
)

Variables

var (
	DefaultSecretsCapabiltities = []string{CreateCapability, ReadCapability, UpdateCapability, DeleteCapability, ListCapability}
)

Functions

func CreateVault

func CreateVault(kubeClient kubernetes.Interface, vaultOperatorClient versioned.Interface, name string, ns string,
	gcpServiceAccountSecretName string, gcpConfig *GCPConfig, authServiceAccount string,
	authServiceAccountNamespace string, secretsPathPrefix string) error

CreateVault creates a new vault backed by GCP KMS and storage

func DeleteVault

func DeleteVault(vaultOperatorClient versioned.Interface, name string, ns string) error

DeleteVault delete a Vault resource

func FindVault

func FindVault(vaultOperatorClient versioned.Interface, name string, ns string) bool

FindVault checks if a vault is available

func GetAuthSaName

func GetAuthSaName(vault v1alpha1.Vault) string

GetAuthSaName gets the Auth Service Account name for the vault

func GetVault

func GetVault(vaultOperatorClient versioned.Interface, name string, ns string) (*v1alpha1.Vault, error)

GetVault gets a specific vault

func VaultGcpServiceAccountSecretName

func VaultGcpServiceAccountSecretName(vaultName string, clusterName string) string

VaultGcpServiceAccountSecretName builds the secret name where the GCP service account is stored

Types

type GCPConfig

type GCPConfig struct {
	ProjectId   string
	KmsKeyring  string
	KmsKey      string
	KmsLocation string
	GcsBucket   string
}

GCPConfig keeps the configuration for Google Cloud

type GCSConfig

type GCSConfig struct {
	Bucket    string `json:"bucket"`
	HaEnabled string `json:"ha_enabled"`
}

type JxVaulter

type JxVaulter struct {
	// contains filtered or unexported fields
}

func (*JxVaulter) Config

func (v *JxVaulter) Config() (vaultUrl url.URL, vaultToken string, err error)

func (*JxVaulter) GetVaultClient

func (v *JxVaulter) GetVaultClient() *api.Client

GetVaultClient gets the underlying vault client

func (*JxVaulter) Secrets

func (v *JxVaulter) Secrets() ([]string, error)

type Listener

type Listener struct {
	Tcp Tcp `json:"tcp"`
}

type PathPolicy

type PathPolicy struct {
	Prefix       string   `hcl:",key"`
	Capabilities []string `hcl:"capabilities" hcle:"omitempty"`
}

PathPolicy defiens a vault path policy

type PathRule

type PathRule struct {
	Path []PathPolicy `hcl:"path" hcle:"omitempty"`
}

PathRule defines a path rule

func (*PathRule) String

func (r *PathRule) String() (string, error)

String encodes a Vault path rule to a string

type Storage

type Storage struct {
	GCS GCSConfig `json:"gcs"`
}

type Tcp

type Tcp struct {
	Address    string `json:"address"`
	TlsDisable bool   `json:"tls_disable"`
}

type Telemetry

type Telemetry struct {
	StatsdAddress string `json:"statsd_address"`
}

type Vault

type Vault struct {
	Name                   string
	Namespace              string
	URL                    string
	AuthServiceAccountName string
}

Vault stores some details of a Vault resource

func GetVaults

func GetVaults(client kubernetes.Interface, vaultOperatorClient versioned.Interface, ns string) ([]*Vault, error)

GetVaults returns all vaults available in a given namespaces

type VaultAuth

type VaultAuth struct {
	Roles []VaultRole `json:"roles"`
	Type  string      `json:"type"`
}

type VaultAuths

type VaultAuths []VaultAuth

type VaultClientFactory

type VaultClientFactory struct {
	Options  common.OptionsInterface
	Selector VaultSelector
	// contains filtered or unexported fields
}

func NewInteractiveVaultClientFactory

func NewInteractiveVaultClientFactory(options common.OptionsInterface) (VaultClientFactory, error)

NewInteractiveVaultClientFactory creates a VaultClientFactory that allows the user to pick vaults if necessary

func NewSystemVaultClientFactory

func NewSystemVaultClientFactory(kubeClient kubernetes.Interface, vaultOperatorClient versioned.Interface, defaultNamespace string) (VaultClientFactory, error)

NewSystemVaultClientFactory Creates a new VaultClientFactory with different options to the above. It doesnt' have CLI support so will fail if it needs interactive input (unlikely)

func (*VaultClientFactory) GetConfigData

func (v *VaultClientFactory) GetConfigData(name string, namespace string) (config *api.Config, jwt string, saName string, err error)

GetConfigData generates the information necessary to configure an api.Client object Returns the api.Config object, the JWT needed to create the auth user in vault, and an error if present

func (VaultClientFactory) NewVaultClient

func (v VaultClientFactory) NewVaultClient(name string, namespace string) (*api.Client, error)

NewVaultClient creates a new api.Client if namespace is nil, then the default namespace of the factory will be used if the name is nil, and only one vault is found, then that vault will be used. Otherwise the user will be prompted to select a vault for the client.

type VaultOptions

type VaultOptions interface {
	common.OptionsInterface
	VaultName() string
	VaultNamespace() string
}

type VaultPolicies

type VaultPolicies []VaultPolicy

type VaultPolicy

type VaultPolicy struct {
	Name  string `json:"name"`
	Rules string `json:"rules"`
}

type VaultRole

type VaultRole struct {
	BoundServiceAccountNames      string `json:"bound_service_account_names"`
	BoundServiceAccountNamespaces string `json:"bound_service_account_namespaces"`
	Name                          string `json:"name"`
	Policies                      string `json:"policies"`
	TTL                           string `json:"ttl"`
}

type VaultSelector

type VaultSelector interface {
	GetVault(name string, namespace string) (*Vault, error)
}

VaultSelector is an interface for selecting a vault from the installed ones on the platform It should pick the most logical one, or give the user a way of picking a vault if there are multiple installed

func NewVaultSelector

func NewVaultSelector(o common.OptionsInterface) (VaultSelector, error)

type Vaulter

type Vaulter interface {
	// Config gets the config required for configuring the official Vault CLI
	Config() (vaultUrl url.URL, vaultToken string, err error)
	// Secrets lists the secrets stored in the vault. Beta - subject to change
	Secrets() ([]string, error)
}

Vaulter is an interface for creating new vault clients We _don't_ want this to just be a mirror of the official api.Client object, as for most of the time you would just want to use the underlying client.

func NewVaulter

func NewVaulter(o VaultOptions) (Vaulter, error)