Merge pull request #57 from gruntwork-io/yori-fix-bug-in-multinamed-json

Fix bug where tls subject info did not allow the second name for the keys

Author: yorinasub17

.circleci/config.yml

@@ -5,13 +5,13 @@ defaults: &defaults
   environment:
     GRUNTWORK_INSTALLER_VERSION: v0.0.21
     TERRATEST_LOG_PARSER_VERSION: v0.13.13
-    MODULE_CI_VERSION: v0.13.12
+    MODULE_CI_VERSION: v0.14.1
     TERRAFORM_VERSION: NONE
     TERRAGRUNT_VERSION: NONE
     PACKER_VERSION: NONE
     GOLANG_VERSION: 1.11.2
     KUBECONFIG: /home/circleci/.kube/config
-    HELM_VERSION: v2.14.0  
+    HELM_VERSION: v2.14.0
 
 
 install_helm_client: &install_helm_client

cmd/common.go

@@ -101,11 +101,25 @@ var (
 
 type TLSSubjectInfo struct {
 	CommonName string `json:"common_name"`
-	Org        string `json:"org" json:"organization"`
-	OrgUnit    string `json:"org_unit" json:"organizational_unit"`
-	City       string `json:"city" json:"locality"`
-	State      string `json:"state" json:"province"`
 	Country    string `json:"country"`
+
+	// These fields have multiple names that they can be encoded as, so we use a different field to handle those.
+	Org     string
+	OrgUnit string
+	City    string
+	State   string
+
+	// These fields are used to handle multiple json encodings for the actual field. For example, Org can be encoded in
+	// json as "org" or "organization". Which one is preferred in the case where both encodings are provided is
+	// arbitrary (undefined behavior).
+	OrgEncodedAsOrg                    *string `json:"org,omitempty"`
+	OrgEncodedAsOrganization           *string `json:"organization,omitempty"`
+	OrgUnitEncodedAsOrgUnit            *string `json:"org_unit,omitempty"`
+	OrgUnitEncodedAsOrganizationalUnit *string `json:"organizational_unit,omitempty"`
+	CityEncodedAsCity                  *string `json:"city,omitempty"`
+	CityEncodedAsLocality              *string `json:"locality,omitempty"`
+	StateEncodedAsState                *string `json:"state,omitempty" json:"province"`
+	StateEncodedAsProvince             *string `json:"province,omitempty"`
 }
 
 type TLSFlags struct {
@@ -128,9 +142,27 @@ func parseOrCreateTLSSubjectInfo(jsonString string) (TLSSubjectInfo, error) {
 			return subjectInfo, errors.WithStackTrace(err)
 		}
 	}
+
+	// Reconcile multiple encoding name fields
+	subjectInfo.Org = getStringFromEncodingOrEmpty(subjectInfo.OrgEncodedAsOrg, subjectInfo.OrgEncodedAsOrganization)
+	subjectInfo.OrgUnit = getStringFromEncodingOrEmpty(subjectInfo.OrgUnitEncodedAsOrgUnit, subjectInfo.OrgUnitEncodedAsOrganizationalUnit)
+	subjectInfo.City = getStringFromEncodingOrEmpty(subjectInfo.CityEncodedAsCity, subjectInfo.CityEncodedAsLocality)
+	subjectInfo.State = getStringFromEncodingOrEmpty(subjectInfo.StateEncodedAsState, subjectInfo.StateEncodedAsProvince)
+
 	return subjectInfo, nil
 }
 
+// setStringFromEncoding will return the first non-empty string from the list of strings passed in, or empty string if
+// they are all unset.
+func getStringFromEncodingOrEmpty(encodings ...*string) string {
+	for _, encoding := range encodings {
+		if encoding != nil && *encoding != "" {
+			return *encoding
+		}
+	}
+	return ""
+}
+
 // parseTLSFlagsToPkixName takes the CLI args related to setting up the Distinguished Name identifier of the TLS
 // certificate and converts them to the pkix.Name struct.
 func parseTLSFlagsToPkixName(cliContext *cli.Context, tlsFlags TLSFlags) (pkix.Name, error) {

cmd/common_test.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseTLSSubjectInfoJsonOrgOrgUnit(t *testing.T) {
+	t.Parallel()
+	subjectInfo, err := parseOrCreateTLSSubjectInfo(`{"org": "Gruntwork", "org_unit": "Eng"}`)
+	assert.NoError(t, err)
+	assert.Equal(t, subjectInfo.Org, "Gruntwork")
+	assert.Equal(t, subjectInfo.OrgUnit, "Eng")
+}
+
+func TestParseTLSSubjectInfoJsonOrganizationOrganizationalUnit(t *testing.T) {
+	t.Parallel()
+	subjectInfo, err := parseOrCreateTLSSubjectInfo(`{"organization": "Gruntwork", "organizational_unit": "Eng"}`)
+	assert.NoError(t, err)
+	assert.Equal(t, subjectInfo.Org, "Gruntwork")
+	assert.Equal(t, subjectInfo.OrgUnit, "Eng")
+}