Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport 1.8.4: Fix 1.8 regression preventing email addresses being used as common name within pki certificates #12723

Merged
merged 2 commits into from
Oct 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion builtin/logical/pki/cert_util.go
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,9 @@ func validateNames(b *backend, data *inputBundle, names []string) string {
// is enabled
if data.role.AllowBareDomains &&
(strings.EqualFold(sanitizedName, currDomain) ||
(isEmail && strings.EqualFold(emailDomain, currDomain))) {
(isEmail && strings.EqualFold(emailDomain, currDomain)) ||
// Handle the use case of AllowedDomain being an email address
(isEmail && strings.EqualFold(name, currDomain))) {
valid = true
break
}
Expand Down
71 changes: 59 additions & 12 deletions builtin/logical/pki/cert_util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ func TestPki_PermitFQDNs(t *testing.T) {

cases := map[string]struct {
input *inputBundle
expected []string
expectedDnsNames []string
expectedEmails []string
}{
"base valid case": {
input: &inputBundle{
Expand All @@ -181,7 +182,8 @@ func TestPki_PermitFQDNs(t *testing.T) {
EnforceHostnames: true,
},
},
expected: []string{"example.com."},
expectedDnsNames: []string{"example.com."},
expectedEmails: []string{},
},
"case insensitivity validation": {
input: &inputBundle{
Expand All @@ -199,20 +201,65 @@ func TestPki_PermitFQDNs(t *testing.T) {
MaxTTL: 3600,
},
},
expected: []string{"Example.Net", "eXaMPLe.COM"},
expectedDnsNames: []string{"Example.Net", "eXaMPLe.COM"},
expectedEmails: []string{},
},
"case email as AllowedDomain with bare domains": {
input: &inputBundle{
apiData: &framework.FieldData{
Schema: fields,
Raw: map[string]interface{}{
"common_name": "[email protected]",
"ttl": 3600,
},
},
role: &roleEntry{
AllowedDomains: []string{"[email protected]"},
AllowBareDomains: true,
MaxTTL: 3600,
},
},
expectedDnsNames: []string{},
expectedEmails: []string{"[email protected]"},
},
"case email common name with bare domains": {
input: &inputBundle{
apiData: &framework.FieldData{
Schema: fields,
Raw: map[string]interface{}{
"common_name": "[email protected]",
"ttl": 3600,
},
},
role: &roleEntry{
AllowedDomains: []string{"testemail.com"},
AllowBareDomains: true,
MaxTTL: 3600,
},
},
expectedDnsNames: []string{},
expectedEmails: []string{"[email protected]"},
},
}

for _, testCase := range cases {
cb, err := generateCreationBundle(&b, testCase.input, nil, nil)
if err != nil {
t.Fatalf("Error: %v", err)
}
for name, testCase := range cases {
t.Run(name, func(t *testing.T) {
cb, err := generateCreationBundle(&b, testCase.input, nil, nil)
if err != nil {
t.Fatalf("Error: %v", err)
}

actual := cb.Params.DNSNames
actualDnsNames := cb.Params.DNSNames

if !reflect.DeepEqual(testCase.expected, actual) {
t.Fatalf("Expected %v, got %v", testCase.expected, actual)
}
if !reflect.DeepEqual(testCase.expectedDnsNames, actualDnsNames) {
t.Fatalf("Expected dns names %v, got %v", testCase.expectedDnsNames, actualDnsNames)
}

actualEmails := cb.Params.EmailAddresses

if !reflect.DeepEqual(testCase.expectedEmails, actualEmails) {
t.Fatalf("Expected email addresses %v, got %v", testCase.expectedEmails, actualEmails)
}
})
}
}
3 changes: 3 additions & 0 deletions changelog/12716.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
pki: Fix regression preventing email addresses being used as a common name within certificates
```