formidable/internal/data/format/yaml/encoder_handler.go
William Petit e6258f37ac feat: ansible-vault values auto retagging in yaml format
Using the YAML encoder, Formidable is now capable of detecting et
retagging ansible-vault [1] encrypted values.

You can use the query parameter 'ansible_vault=no' to disable this
behavior.

[1] https://docs.ansible.com/ansible/latest/user_guide/vault.html
2022-08-01 10:03:21 +02:00

94 lines
1.9 KiB
Go

package yaml
import (
"bytes"
"io"
"net/url"
"path"
"path/filepath"
"strings"
"forge.cadoles.com/wpetit/formidable/internal/data/format"
"github.com/pkg/errors"
"gopkg.in/yaml.v3"
)
const YAMLTagAnsibleVaultValuesQueryParam = "ansible_vault"
type EncoderHandler struct{}
func (d *EncoderHandler) Match(url *url.URL) bool {
ext := filepath.Ext(path.Join(url.Host, url.Path))
return ExtensionYAML.MatchString(ext) ||
format.MatchURLQueryFormat(url, FormatYAML)
}
func (d *EncoderHandler) Encode(url *url.URL, data interface{}) (io.Reader, error) {
var output bytes.Buffer
encoder := yaml.NewEncoder(&output)
if err := encoder.Encode(data); err != nil {
return nil, errors.WithStack(err)
}
if shouldTransformAnsibleVault(url) {
if err := tagAnsibleVaultValues(&output); err != nil {
return nil, errors.WithStack(err)
}
}
return &output, nil
}
func NewEncoderHandler() *EncoderHandler {
return &EncoderHandler{}
}
func shouldTransformAnsibleVault(url *url.URL) bool {
return !url.Query().Has(YAMLTagAnsibleVaultValuesQueryParam) || url.Query().Get(YAMLTagAnsibleVaultValuesQueryParam) == "yes"
}
func tagAnsibleVaultValues(buf *bytes.Buffer) error {
decoder := yaml.NewDecoder(buf)
var node yaml.Node
if err := decoder.Decode(&node); err != nil {
return errors.WithStack(err)
}
walkNodeTree(&node, func(node *yaml.Node) {
isAnsibleVaultNode := node.Tag == "!!str" && strings.HasPrefix(strings.TrimSpace(node.Value), "$ANSIBLE_VAULT")
if !isAnsibleVaultNode {
return
}
node.Tag = "!vault"
node.Style = yaml.LiteralStyle | yaml.TaggedStyle
})
buf.Reset()
encoder := yaml.NewEncoder(buf)
if err := encoder.Encode(node.Content[0]); err != nil {
return errors.WithStack(err)
}
return nil
}
func walkNodeTree(node *yaml.Node, fn func(node *yaml.Node)) {
fn(node)
if node.Content == nil {
return
}
for _, sub := range node.Content {
walkNodeTree(sub, fn)
}
}