utils

Documentation

Index

• Variables
• func CompareStringAndByteSlices(valueString *string, valueByte []byte) bool
• func ConvertKeys(strategy esv1beta1.ExternalSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error)
• func ConvertToType[T any](obj any) (T, error)
• func Decode(strategy esv1beta1.ExternalSecretDecodingStrategy, in []byte) ([]byte, error)
• func DecodeMap(strategy esv1beta1.ExternalSecretDecodingStrategy, in map[string][]byte) (map[string][]byte, error)
• func Deref[V any](v *V) V
• func ErrorContains(out error, want string) bool
• func FetchCACertFromSource(ctx context.Context, opts CreateCertOpts) ([]byte, error)
• func FetchValueFromMetadata[T any](key string, data *apiextensionsv1.JSON, def T) (t T, _ error)
• func GetByteValue(v any) ([]byte, error)
• func GetByteValueFromMap(data map[string]any, key string) ([]byte, error)
• func IsNil(i any) bool
• func JSONMarshal(t any) ([]byte, error)
• func MergeByteMap(dst, src map[string][]byte) map[string][]byte
• func MergeStringMap(dest, src map[string]string)
• func NetworkValidate(endpoint string, timeout time.Duration) error
• func ObjectHash(object any) string
• func Ptr[T any](i T) *T
• func ReverseKeys(strategy esv1alpha1.PushSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error)
• func RewriteMap(operations []esv1beta1.ExternalSecretRewrite, in map[string][]byte) (map[string][]byte, error)
• func RewriteRegexp(operation esv1beta1.ExternalSecretRewriteRegexp, in map[string][]byte) (map[string][]byte, error)
• func RewriteTransform(operation esv1beta1.ExternalSecretRewriteTransform, in map[string][]byte) (map[string][]byte, error)
• func ValidateKeys(in map[string][]byte) error
• func ValidateReferentSecretSelector(store esv1beta1.GenericStore, ref esmeta.SecretKeySelector) error
• func ValidateReferentServiceAccountSelector(store esv1beta1.GenericStore, ref esmeta.ServiceAccountSelector) error
• func ValidateSecretSelector(store esv1beta1.GenericStore, ref esmeta.SecretKeySelector) error
• func ValidateServiceAccountSelector(store esv1beta1.GenericStore, ref esmeta.ServiceAccountSelector) error
• type CreateCertOpts

Variables

var (
	ErrUnexpectedKey = errors.New("unexpected key in data")
	ErrSecretType    = errors.New("can not handle secret value with type")
)

Functions

func CompareStringAndByteSlices

func CompareStringAndByteSlices(valueString *string, valueByte []byte) bool

func ConvertKeys

func ConvertKeys(strategy esv1beta1.ExternalSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error)

ConvertKeys converts a secret map into a valid key. Replaces any non-alphanumeric characters depending on convert strategy.

func ConvertToType

func ConvertToType[T any](obj any) (T, error)

func Decode

func Decode(strategy esv1beta1.ExternalSecretDecodingStrategy, in []byte) ([]byte, error)

func DecodeMap

func DecodeMap(strategy esv1beta1.ExternalSecretDecodingStrategy, in map[string][]byte) (map[string][]byte, error)

DecodeMap decodes values from a secretMap.

func Deref

func Deref[V any](v *V) V

func ErrorContains

func ErrorContains(out error, want string) bool

func FetchCACertFromSource

func FetchCACertFromSource(ctx context.Context, opts CreateCertOpts) ([]byte, error)

FetchCACertFromSource creates a CertPool using either a CABundle directly, or a ConfigMap / Secret.

func FetchValueFromMetadata

func FetchValueFromMetadata[T any](key string, data *apiextensionsv1.JSON, def T) (t T, _ error)

FetchValueFromMetadata fetches a key from a metadata if it exists. It will recursively look in embedded values as well. Must be a unique key, otherwise it will just return the first occurrence.

func GetByteValue

func GetByteValue(v any) ([]byte, error)

func GetByteValueFromMap

func GetByteValueFromMap(data map[string]any, key string) ([]byte, error)

func IsNil

func IsNil(i any) bool

IsNil checks if an Interface is nil.

func JSONMarshal

func JSONMarshal(t any) ([]byte, error)

JSONMarshal takes an interface and returns a new escaped and encoded byte slice.

func MergeByteMap

func MergeByteMap(dst, src map[string][]byte) map[string][]byte

MergeByteMap merges map of byte slices.

func MergeStringMap

func MergeStringMap(dest, src map[string]string)

MergeStringMap performs a deep clone from src to dest.

func NetworkValidate

func NetworkValidate(endpoint string, timeout time.Duration) error

func ObjectHash

func ObjectHash(object any) string

ObjectHash calculates md5 sum of the data contained in the secret.

func Ptr

func Ptr[T any](i T) *T

func ReverseKeys

func ReverseKeys(strategy esv1alpha1.PushSecretConversionStrategy, in map[string][]byte) (map[string][]byte, error)

ReverseKeys reverses a secret map into a valid key map as expected by push secrets. Replaces the unicode encoded representation characters back to the actual unicode character depending on convert strategy.

func RewriteMap

func RewriteMap(operations []esv1beta1.ExternalSecretRewrite, in map[string][]byte) (map[string][]byte, error)

func RewriteRegexp

func RewriteRegexp(operation esv1beta1.ExternalSecretRewriteRegexp, in map[string][]byte) (map[string][]byte, error)

RewriteRegexp rewrites a single Regexp Rewrite Operation.

func RewriteTransform

func RewriteTransform(operation esv1beta1.ExternalSecretRewriteTransform, in map[string][]byte) (map[string][]byte, error)

RewriteTransform applies string transformation on each secret key name to rewrite.

func ValidateKeys

func ValidateKeys(in map[string][]byte) error

ValidateKeys checks if the keys in the secret map are valid keys for a Kubernetes secret.

func ValidateReferentSecretSelector

func ValidateReferentSecretSelector(store esv1beta1.GenericStore, ref esmeta.SecretKeySelector) error

ValidateReferentSecretSelector allows cluster scoped store without namespace this should replace above ValidateServiceAccountSelector once all providers support referent auth.

func ValidateReferentServiceAccountSelector

func ValidateReferentServiceAccountSelector(store esv1beta1.GenericStore, ref esmeta.ServiceAccountSelector) error

ValidateReferentServiceAccountSelector allows cluster scoped store without namespace this should replace above ValidateServiceAccountSelector once all providers support referent auth.

func ValidateSecretSelector

func ValidateSecretSelector(store esv1beta1.GenericStore, ref esmeta.SecretKeySelector) error

ValidateSecretSelector just checks if the namespace field is present/absent depending on the secret store type. We MUST NOT check the name or key property here. It MAY be defaulted by the provider.

func ValidateServiceAccountSelector

func ValidateServiceAccountSelector(store esv1beta1.GenericStore, ref esmeta.ServiceAccountSelector) error

ValidateServiceAccountSelector just checks if the namespace field is present/absent depending on the secret store type. We MUST NOT check the name or key property here. It MAY be defaulted by the provider.

Types

type CreateCertOpts

type CreateCertOpts struct {
	CABundle   []byte
	CAProvider *esv1beta1.CAProvider
	StoreKind  string
	Namespace  string
	Client     client.Client
}

CreateCertOpts contains options for a cert pool creation.