yamlpath

README

YAMLPath Extractor Modifier (yp)

This plugin provides a YAML JSONPath modifier for spelunk. It allows you to extract specific values from YAML secrets using JSONPath syntax.

Usage

package main

import (
	"context"
	"fmt"

	"github.com/detro/spelunk"
	"github.com/detro/spelunk/plugin/modifier/yamlpath"
)

func main() {
	s, _ := spelunk.NewSpelunker(yamlpath.WithYAMLPath())
	
	// Assuming `plain://...` contains `data: { foo: bar }`
	res, _ := s.DigUp(context.Background(), "plain://.../?yp=$.data.foo")
	
	fmt.Println(res) // Outputs: bar
}

Documentation

Index

• Variables
• func WithYAMLPath() spelunk.SpelunkerOption
• type SecretModifierYAMLPath
  • func (s *SecretModifierYAMLPath) Modify(_ context.Context, secretValue string, mod string) (string, error)
  • func (s *SecretModifierYAMLPath) Type() string

Variables

var (
	ErrYAMLPathInvalid        = fmt.Errorf("invalid YAML JSONPath expression")
	ErrYAMLPathFailed         = fmt.Errorf("failed to apply YAML JSONPath")
	ErrYAMLPathMatchingFailed = fmt.Errorf("failed to match YAML JSONPath")
	ErrSecretNotYAML          = fmt.Errorf("secret is not a valid YAML")
)

Functions

func WithYAMLPath

func WithYAMLPath() spelunk.SpelunkerOption

WithYAMLPath adds the YAML JSONPath modifier to a Spelunker.

Types

type SecretModifierYAMLPath

type SecretModifierYAMLPath struct{}

SecretModifierYAMLPath is a modifier that can extract a specific field out of a YAML stored in a secret value. It parses the YAML into an object and applies standard JSONPath to it.

func (*SecretModifierYAMLPath) Modify

func (s *SecretModifierYAMLPath) Modify(
	_ context.Context,
	secretValue string,
	mod string,
) (string, error)

func (*SecretModifierYAMLPath) Type

func (s *SecretModifierYAMLPath) Type() string