Skip to content

core: update SPIFFE certificate extraction to comply with X509-SVID spec #12961

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.

Sign up for GitHub

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

Open
kannanjgithub wants to merge 1 commit into
base: master
Choose a base branch
from
Open

core: update SPIFFE certificate extraction to comply with X509-SVID spec #12961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 2 additions & 8 deletions core/src/main/java/io/grpc/internal/SpiffeUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,14 +231,8 @@ private static List<X509Certificate> extractCert(List<Map<String, ?>> keysNode,
for (Map<String, ?> keyNode : keysNode) {
checkJwkEntry(keyNode, trustDomainName);
List<String> rawCerts = JsonUtil.getListOfStrings(keyNode, "x5c");
if (rawCerts == null) {
throw new IllegalArgumentException(String.format("'x5c' parameter is required. Certificate "
+ "loading for trust domain '%s' failed.", trustDomainName));
}
if (rawCerts.size() != 1) {
throw new IllegalArgumentException(String.format("Exactly 1 certificate is expected, but "
+ "%s found. Certificate loading for trust domain '%s' failed.", rawCerts.size(),
trustDomainName));
if (rawCerts == null || rawCerts.isEmpty()) {
continue;
}
InputStream stream = new ByteArrayInputStream((CERTIFICATE_PREFIX + rawCerts.get(0) + "\n"
+ CERTIFICATE_SUFFIX)
Expand Down
59 changes: 50 additions & 9 deletions core/src/test/java/io/grpc/internal/SpiffeUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ public static class CertificateApiTest {
private static final String SPIFFE_TRUST_BUNDLE_WRONG_ROOT = "spiffebundle_wrong_root.json";
private static final String SPIFFE_TRUST_BUNDLE_WRONG_SEQ = "spiffebundle_wrong_seq_type.json";
private static final String SPIFFE_TRUST_BUNDLE_MISSING_X5C = "spiffebundle_missing_x5c.json";
private static final String SPIFFE_TRUST_BUNDLE_EMPTY_X5C = "spiffebundle_empty_x5c.json";
private static final String SPIFFE_TRUST_BUNDLE_IGNORED_KEYS = "spiffebundle_ignored_keys.json";
private static final String DOMAIN_ERROR_MESSAGE =
" Certificate loading for trust domain 'google.com' failed.";

Expand Down Expand Up @@ -330,6 +332,54 @@ public void loadTrustBundleFromFileSuccessTest() throws Exception {
assertEquals("foo.bar.com", spiffeId_ec.get().getTrustDomain());
}

@Test
public void loadTrustBundleFromFileWithMultiCertsSuccessTest() throws Exception {
SpiffeBundle tb = SpiffeUtil.loadTrustBundleFromFile(
copyFileToTmp(SPIFFE_TRUST_BUNDLE_WRONG_MULTI_CERTS));
assertEquals(1, tb.getSequenceNumbers().size());
assertEquals(123L, (long) tb.getSequenceNumbers().get("google.com"));
assertEquals(1, tb.getBundleMap().size());
assertEquals(1, tb.getBundleMap().get("google.com").size());
Optional<SpiffeId> spiffeId = SpiffeUtil.extractSpiffeId(
tb.getBundleMap().get("google.com").toArray(new X509Certificate[0]));
assertTrue(spiffeId.isPresent());
assertEquals("foo.bar.com", spiffeId.get().getTrustDomain());
}

@Test
public void loadTrustBundleFromFileWithMissingX5cSuccessTest() throws Exception {
SpiffeBundle tb = SpiffeUtil.loadTrustBundleFromFile(
copyFileToTmp(SPIFFE_TRUST_BUNDLE_MISSING_X5C));
assertEquals(1, tb.getBundleMap().size());
assertEquals(1, tb.getBundleMap().get("google.com").size());
}

@Test
public void loadTrustBundleFromFileWithEmptyX5cSuccessTest() throws Exception {
SpiffeBundle tb = SpiffeUtil.loadTrustBundleFromFile(
copyFileToTmp(SPIFFE_TRUST_BUNDLE_EMPTY_X5C));
assertEquals(1, tb.getBundleMap().size());
assertEquals(1, tb.getBundleMap().get("google.com").size());
Optional<SpiffeId> spiffeId = SpiffeUtil.extractSpiffeId(
tb.getBundleMap().get("google.com").toArray(new X509Certificate[0]));
assertTrue(spiffeId.isPresent());
assertEquals("foo.bar.com", spiffeId.get().getTrustDomain());
}

@Test
public void loadTrustBundleFromFileWithIgnoredKeysSuccessTest() throws Exception {
SpiffeBundle tb = SpiffeUtil.loadTrustBundleFromFile(
copyFileToTmp(SPIFFE_TRUST_BUNDLE_IGNORED_KEYS));
assertEquals(1, tb.getSequenceNumbers().size());
assertEquals(123L, (long) tb.getSequenceNumbers().get("google.com"));
assertEquals(1, tb.getBundleMap().size());
assertEquals(1, tb.getBundleMap().get("google.com").size());
Optional<SpiffeId> spiffeId = SpiffeUtil.extractSpiffeId(
tb.getBundleMap().get("google.com").toArray(new X509Certificate[0]));
assertTrue(spiffeId.isPresent());
assertEquals("foo.bar.com", spiffeId.get().getTrustDomain());
}

@Test
public void loadTrustBundleFromFileFailureTest() {
// Check the exception if JSON root element is different from 'trust_domains'
Expand All @@ -352,10 +402,6 @@ public void loadTrustBundleFromFileFailureTest() {
iae = assertThrows(IllegalArgumentException.class, () -> SpiffeUtil
.loadTrustBundleFromFile(copyFileToTmp(SPIFFE_TRUST_BUNDLE_CORRUPTED_CERT)));
assertEquals("Certificate can't be parsed." + DOMAIN_ERROR_MESSAGE, iae.getMessage());
// Check the exception if a key entry is missing the 'x5c' parameter
iae = assertThrows(IllegalArgumentException.class, () -> SpiffeUtil
.loadTrustBundleFromFile(copyFileToTmp(SPIFFE_TRUST_BUNDLE_MISSING_X5C)));
assertEquals("'x5c' parameter is required." + DOMAIN_ERROR_MESSAGE, iae.getMessage());
// Check the exception if 'kty' value differs from 'RSA'
iae = assertThrows(IllegalArgumentException.class, () -> SpiffeUtil
.loadTrustBundleFromFile(copyFileToTmp(SPIFFE_TRUST_BUNDLE_WRONG_KTY)));
Expand All @@ -371,11 +417,6 @@ public void loadTrustBundleFromFileFailureTest() {
.loadTrustBundleFromFile(copyFileToTmp(SPIFFE_TRUST_BUNDLE_WRONG_USE)));
assertEquals("'use' parameter must be 'x509-svid' but 'i_am_not_x509-svid' found."
+ DOMAIN_ERROR_MESSAGE, iae.getMessage());
// Check the exception if multiple certs are provided for 'x5c'
iae = assertThrows(IllegalArgumentException.class, () -> SpiffeUtil
.loadTrustBundleFromFile(copyFileToTmp(SPIFFE_TRUST_BUNDLE_WRONG_MULTI_CERTS)));
assertEquals("Exactly 1 certificate is expected, but 2 found." + DOMAIN_ERROR_MESSAGE,
iae.getMessage());
}

@Test
Expand Down
19 changes: 19 additions & 0 deletions core/src/test/resources/io/grpc/internal/spiffebundle_empty_x5c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"trust_domains": {
"google.com": {
"spiffe_sequence": 123,
"keys": [
{
"kty": "RSA",
"use": "x509-svid",
"x5c": []
},
{
"kty": "RSA",
"use": "x509-svid",
"x5c": ["MIIFsjCCA5qgAwIBAgIURygVMMzdr+Q7rsUaz189JozyHMwwDQYJKoZIhvcNAQELBQAwTjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMQwwCgYDVQQHDANTVkwxDTALBgNVBAoMBGdSUEMxFTATBgNVBAMMDHRlc3QtY2xpZW50MTAeFw0yMTEyMjMxODQyNTJaFw0zMTEyMjExODQyNTJaME4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEMMAoGA1UEBwwDU1ZMMQ0wCwYDVQQKDARnUlBDMRUwEwYDVQQDDAx0ZXN0LWNsaWVudDEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDJ4AqpGetyVSqGUuBJLVFla+7bEfca7UYzfVSSZLZ/X+JDmWIVN8UIPuFib5jhMEc3XaUnFXUmM7zEtz/ZG5hapwLwOb2C3ZxOP6PQjYCJxbkLie+b43UQrFu1xxd3vMhVJgcj/AIxEpmszuqOa6kUrkYifjJADQ+64kZgl66bsTdXMCzpxyFl9xUfff59L8OX+HUfAcoZz3emjg3ZJPYURQEmjdZTOau1EjFilwHgd989Jt7NKgx30NXoHmw7nusVBIY94fL2VKN3f1XVm0dHu5NI279Q6zr0ZBU7k5T3IeHnzsUesQS4NGlklDWoVTKk73Uv9Pna8yQsSW757PEbHOGp9Knu4bnoGPOlsG81yIPipO6hTgGFK24pF97M9kpGbWqYX4+2vLlrCAfcmsHqaUPmQlYeRVTT6vw7ctYo2kyUYGtnODXk76LqewRBVvkzx75QUhfjAyb740YcDmIenc56Tq6gebJHjhEmVSehR6xIpXP7SVeurTyhPsEQnpJHtgs4dcwWOZp7BvPNzHXmJqfr7vsshie3vS5kQ0u1e1yqAqXgyDjqKXOkx+dpgUTehSJHhPNHvTc5LXRsvvXKYz6FrwR/DZ8t7BNEvPeLjFgxpH7QVJFLCvCbXs5K6yYbsnLfxFIBPRnrbJkIsK+sQwnRdnsiUdPsTkG5B2lQfQIDAQABo4GHMIGEMB0GA1UdDgQWBBQ2lBp0PiRHHvQ5IRURm8aHsj4RETAfBgNVHSMEGDAWgBQ2lBp0PiRHHvQ5IRURm8aHsj4RETAPBgNVHRMBAf8EBTADAQH/MDEGA1UdEQQqMCiGJnNwaWZmZTovL2Zvby5iYXIuY29tL2NsaWVudC93b3JrbG9hZC8xMA0GCSqGSIb3DQEBCwUAA4ICAQA1mSkgRclAl+E/aS9zJ7t8+Y4n3T24nOKKveSIjxXm/zjhWqVsLYBI6kglWtih2+PELvU8JdPqNZK34Kl0Q6FWpVSGDdWN1i6NyORt2ocggL3ke3iXxRk3UpUKJmqwz81VhA2KUHnMlyE0IufFfZNwNWWHBv13uJfRbjeQpKPhU+yf4DeXrsWcvrZlGvAET+mcplafUzCp7Iv+PcISJtUerbxbVtuHVeZCLlgDXWkLAWJN8rf0dIG4x060LJ+j6j9uRVhb9sZn1HJV+j4XdIYm1VKilluhOtNwP2d3Ox/JuTBxf7hFHXZPfMagQE5k5PzmxRaCAEMJ1l2DvUbZw+shJfSNoWcBo2qadnUaWT3BmmJRBDh7ZReib/RQ1Rd4ygOyzP3E0vkV4/gqyjLdApXh5PZP8KLQZ+1JN/sdWt7VfIt9wYOpkIqujdll51ESHzwQeAK9WVCB4UvVz6zdhItB9CRbXPreWC+wCB1xDovIzFKOVsLs5+Gqs1m7VinG2LxbDqaKyo/FB0Hxx0acBNzezLWoDwXYQrN0T0S4pnqhKD1CYPpdArBkNezUYAjS725FkApuK+mnBX3U0msBffEaUEOkcyar1EW2m/33vpetD/k3eQQkmvQf4Hbiu9AF+9cNDm/hMuXEw5EXGA91fn0891b5eEW8BJHXX0jri0aN8g=="]
}
]
}
}
}
23 changes: 23 additions & 0 deletions core/src/test/resources/io/grpc/internal/spiffebundle_ignored_keys.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"trust_domains": {
"google.com": {
"spiffe_sequence": 123,
"keys": [
{
"kty": "RSA",
"use": "x509-svid"
},
{
"kty": "RSA",
"use": "x509-svid",
"x5c": []
},
{
"kty": "RSA",
"use": "x509-svid",
"x5c": ["MIIFsjCCA5qgAwIBAgIURygVMMzdr+Q7rsUaz189JozyHMwwDQYJKoZIhvcNAQELBQAwTjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMQwwCgYDVQQHDANTVkwxDTALBgNVBAoMBGdSUEMxFTATBgNVBAMMDHRlc3QtY2xpZW50MTAeFw0yMTEyMjMxODQyNTJaFw0zMTEyMjExODQyNTJaME4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEMMAoGA1UEBwwDU1ZMMQ0wCwYDVQQKDARnUlBDMRUwEwYDVQQDDAx0ZXN0LWNsaWVudDEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDJ4AqpGetyVSqGUuBJLVFla+7bEfca7UYzfVSSZLZ/X+JDmWIVN8UIPuFib5jhMEc3XaUnFXUmM7zEtz/ZG5hapwLwOb2C3ZxOP6PQjYCJxbkLie+b43UQrFu1xxd3vMhVJgcj/AIxEpmszuqOa6kUrkYifjJADQ+64kZgl66bsTdXMCzpxyFl9xUfff59L8OX+HUfAcoZz3emjg3ZJPYURQEmjdZTOau1EjFilwHgd989Jt7NKgx30NXoHmw7nusVBIY94fL2VKN3f1XVm0dHu5NI279Q6zr0ZBU7k5T3IeHnzsUesQS4NGlklDWoVTKk73Uv9Pna8yQsSW757PEbHOGp9Knu4bnoGPOlsG81yIPipO6hTgGFK24pF97M9kpGbWqYX4+2vLlrCAfcmsHqaUPmQlYeRVTT6vw7ctYo2kyUYGtnODXk76LqewRBVvkzx75QUhfjAyb740YcDmIenc56Tq6gebJHjhEmVSehR6xIpXP7SVeurTyhPsEQnpJHtgs4dcwWOZp7BvPNzHXmJqfr7vsshie3vS5kQ0u1e1yqAqXgyDjqKXOkx+dpgUTehSJHhPNHvTc5LXRsvvXKYz6FrwR/DZ8t7BNEvPeLjFgxpH7QVJFLCvCbXs5K6yYbsnLfxFIBPRnrbJkIsK+sQwnRdnsiUdPsTkG5B2lQfQIDAQABo4GHMIGEMB0GA1UdDgQWBBQ2lBp0PiRHHvQ5IRURm8aHsj4RETAfBgNVHSMEGDAWgBQ2lBp0PiRHHvQ5IRURm8aHsj4RETAPBgNVHRMBAf8EBTADAQH/MDEGA1UdEQQqMCiGJnNwaWZmZTovL2Zvby5iYXIuY29tL2NsaWVudC93b3JrbG9hZC8xMA0GCSqGSIb3DQEBCwUAA4ICAQA1mSkgRclAl+E/aS9zJ7t8+Y4n3T24nOKKveSIjxXm/zjhWqVsLYBI6kglWtih2+PELvU8JdPqNZK34Kl0Q6FWpVSGDdWN1i6NyORt2ocggL3ke3iXxRk3UpUKJmqwz81VhA2KUHnMlyE0IufFfZNwNWWHBv13uJfRbjeQpKPhU+yf4DeXrsWcvrZlGvAET+mcplafUzCp7Iv+PcISJtUerbxbVtuHVeZCLlgDXWkLAWJN8rf0dIG4x060LJ+j6j9uRVhb9sZn1HJV+j4XdIYm1VKilluhOtNwP2d3Ox/JuTBxf7hFHXZPfMagQE5k5PzmxRaCAEMJ1l2DvUbZw+shJfSNoWcBo2qadnUaWT3BmmJRBDh7ZReib/RQ1Rd4ygOyzP3E0vkV4/gqyjLdApXh5PZP8KLQZ+1JN/sdWt7VfIt9wYOpkIqujdll51ESHzwQeAK9WVCB4UvVz6zdhItB9CRbXPreWC+wCB1xDovIzFKOVsLs5+Gqs1m7VinG2LxbDqaKyo/FB0Hxx0acBNzezLWoDwXYQrN0T0S4pnqhKD1CYPpdArBkNezUYAjS725FkApuK+mnBX3U0msBffEaUEOkcyar1EW2m/33vpetD/k3eQQkmvQf4Hbiu9AF+9cNDm/hMuXEw5EXGA91fn0891b5eEW8BJHXX0jri0aN8g=="]
}
]
}
}
}
Loading