masker

Documentation

Index

• Constants
• Variables
• type Client
  • func NewMasker(kubeClient kubernetes.Interface, namespaces ...string) (*Client, error)
  • func (m *Client) GetReplacedWords() []string
  • func (m *Client) LoadSecret(secret *corev1.Secret) error
  • func (m *Client) LoadSecrets(kubeClient kubernetes.Interface, ns string) error
  • func (m *Client) Mask(text string) string
  • func (m *Client) MaskData(logData []byte) []byte

Constants

const (
	// MaskedOut the text that is returned if text is masked out
	// we don't use the length of the actual secret value to avoid giving folks a hint what the value is
	MaskedOut = "****"
)

Variables

var (
	// ShowMaskedPasswords lets you enable in test programs
	ShowMaskedPasswords = false
)

Types

type Client

type Client struct {
	ReplaceWords map[string]string
	LogFn        func(string)
}

Client replaces words in a log from a set of secrets

func NewMasker

func NewMasker(kubeClient kubernetes.Interface, namespaces ...string) (*Client, error)

NewMasker creates a new Client loading secrets from the given namespace

func (*Client) GetReplacedWords

func (m *Client) GetReplacedWords() []string

GetReplacedWords returns all the words that will be replaced

func (*Client) LoadSecret

func (m *Client) LoadSecret(secret *corev1.Secret) error

LoadSecret loads the secret data into the log masker

func (*Client) LoadSecrets

func (m *Client) LoadSecrets(kubeClient kubernetes.Interface, ns string) error

LoadSecrets loads the secrets into the log masker

func (*Client) Mask

func (m *Client) Mask(text string) string

Mask returns the text with all of the secrets masked out

func (*Client) MaskData

func (m *Client) MaskData(logData []byte) []byte

MaskData masks the given data