feat: Fail if placeholder resolves to binary data, that would break yaml

Signed-off-by: Oliver Gondža <ogondza@gmail.com>

Author: olivergondza

pkg/kube/template_test.go

@@ -1,6 +1,7 @@
 package kube
 
 import (
+	"github.com/stretchr/testify/assert"
 	"os"
 	"reflect"
 	"regexp"
@@ -87,6 +88,63 @@ func TestToYAML_Missing_PlaceholdersSpecificPath(t *testing.T) {
 	}
 }
 
+func TestToYAML_BinaryValueInjectedToStringData(t *testing.T) {
+	mv := helpers.MockVault{}
+
+	d := Template{
+		Resource{
+			Kind: "Secret",
+			Annotations: map[string]string{
+				types.AVPPathAnnotation: "path/to/secret",
+			},
+			TemplateData: map[string]interface{}{
+				"apiVersion": "v1",
+				"kind":       "Secret",
+				"metadata": map[string]interface{}{
+					"namespace": "default",
+					"name":      "some-resource",
+					"annotations": map[string]string{
+						types.AVPPathAnnotation: "path/to/secret",
+					},
+				},
+				"data": map[string]interface{}{
+					"d-yscs":      "<yaml-safe-control-chars>",
+					"d-ubd":       "<unsafe-binary-data>",
+					"d-realistic": "<realistic>",
+				},
+				"stringData": map[string]interface{}{
+					"sd-yscc":      "<yaml-safe-control-chars>",
+					"sd-ubd":       "<unsafe-binary-data>",
+					"sd-realistic": "<realistic>",
+				},
+			},
+			Backend: &mv,
+			Data: map[string]interface{}{
+				// Tab and linebreak chars are safe
+				"yaml-safe-control-chars": "\x09first\x0D\x0A\x09second\n",
+				"unsafe-binary-data":      "as\u0001df\nas\x0bdf",
+				"realistic":               "�\u0001\f\u0003�c�ţ8h�\u0001\a�R�\nڒp��Y4���E�m���+��W�%\u000FH��$�(���]�\u000E&\u000E�zi�@�O�X(\f��ߞ\u0003\a�\u000EN(�a#��\u000F��5LF1�}��ݗ��\u000Fk\u0010�i5\u000FcJOϐ\u001F�.\u0000sp)�(5��\u0004a\u0015���\u0004�'�9�\u0002��\ak��M4\u0004~\u007F��:�Y�:�\u001A=]c�\u0004;����\u0013�ʼ��ױ;۹�C\u0001��+o+=��r�\u0011�*d�\u0018����Z�赁\u0004��Ża�\n�.հ\u0014H����\u0017�y�\u0006R�xv�X�i)\u0000��-^�\u0006L�ٲfQsfz�\u001D�ͩ8T6^E��5zk�غ%��B\u0001A�Ը�^\u0005��~�\u0084�\u0004ă����\nq��;�e�f�Ic��\f�\u000F4H]�+ܭU��×�D��\u0017�x�c��\u0017\u0017�{",
+			},
+		},
+	}
+
+	expectedErr := []string{
+		"Replace: could not replace all placeholders in Template:",
+		"placeholder resolved to binary content in sd-ubd: <unsafe-binary-data>",
+		"placeholder resolved to binary content in sd-realistic: <realistic>",
+		"placeholder resolved to binary content in d-ubd: <unsafe-binary-data>",
+		"placeholder resolved to binary content in d-realistic: <realistic>",
+	}
+
+	err := d.Replace()
+	if err == nil {
+		yaml, _ := d.ToYAML()
+		t.Fatalf("expected error %s but got success, producing: %s", expectedErr, yaml)
+	}
+
+	assert.ElementsMatch(t, strings.Split(err.Error(), "\n"), expectedErr)
+}
+
 func TestToYAML_RemoveMissing(t *testing.T) {
 	mv := helpers.MockVault{}
 

pkg/kube/util.go

@@ -5,14 +5,14 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
+	"github.com/argoproj-labs/argocd-vault-plugin/pkg/types"
+	"github.com/argoproj-labs/argocd-vault-plugin/pkg/utils"
+	k8yaml "k8s.io/apimachinery/pkg/util/yaml"
 	"reflect"
 	"regexp"
 	"strconv"
 	"strings"
-
-	"github.com/argoproj-labs/argocd-vault-plugin/pkg/types"
-	"github.com/argoproj-labs/argocd-vault-plugin/pkg/utils"
-	k8yaml "k8s.io/apimachinery/pkg/util/yaml"
+	"unicode"
 )
 
 type missingKeyError struct {
@@ -199,7 +199,21 @@ func genericReplacement(key, value string, resource Resource) (_ interface{}, er
 		return nonStringReplacement, err
 	}
 
-	return string(res), err
+	sres := string(res)
+	if containsBinary(sres) {
+		e := fmt.Errorf("placeholder resolved to binary content in %s: %s", key, value)
+		err = append(err, e)
+	}
+	return sres, err
+}
+
+func containsBinary(rep string) bool {
+	for _, r := range rep {
+		if unicode.IsControl(r) && r != '\t' && r != '\n' && r != '\r' {
+			return true
+		}
+	}
+	return false
 }
 
 func configReplacement(key, value string, resource Resource) (interface{}, []error) {