forked from quarkusio/quarkus
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
TLS - Enable Policy Configuration for Expired or Not Yet Valid Certif…
…icates This commit introduces the ability to configure a policy for handling expired or not-yet-valid certificates presented during TLS handshakes (anywhere in the certificate chain). Previously, the trust store could not be configured to reject or warn about such certificates. While surprising, this behavior aligns with RFC 3280 and related specifications. With this change, users can now define the desired behavior using the following options: * IGNORE – Matches the previous behavior, allowing expired or not-yet-valid certificates without any warning. * WARN – Logs a warning message when such certificates are detected in the chain (new default). * REJECT – Rejects the handshake entirely if an expired or not-yet-valid certificate is encountered.
- Loading branch information
1 parent
805c3f3
commit 95ca6bf
Showing
10 changed files
with
703 additions
and
4 deletions.
There are no files selected for viewing
100 changes: 100 additions & 0 deletions
100
...nsions/tls-registry/deployment/src/test/java/io/quarkus/tls/ExpiredJKSTrustStoreTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
package io.quarkus.tls; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
||
import java.util.concurrent.CountDownLatch; | ||
|
||
import javax.net.ssl.SSLHandshakeException; | ||
|
||
import jakarta.inject.Inject; | ||
|
||
import org.jboss.shrinkwrap.api.ShrinkWrap; | ||
import org.jboss.shrinkwrap.api.asset.StringAsset; | ||
import org.jboss.shrinkwrap.api.spec.JavaArchive; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
||
import io.quarkus.test.QuarkusUnitTest; | ||
import io.smallrye.certs.Format; | ||
import io.smallrye.certs.junit5.Certificate; | ||
import io.smallrye.certs.junit5.Certificates; | ||
import io.vertx.core.Vertx; | ||
import io.vertx.core.http.HttpServerOptions; | ||
import io.vertx.ext.web.client.WebClient; | ||
import io.vertx.ext.web.client.WebClientOptions; | ||
|
||
@Certificates(baseDir = "target/certs", certificates = { | ||
@Certificate(name = "expired-test-formats", password = "password", formats = { Format.JKS, Format.PEM, | ||
Format.PKCS12 }, duration = -5) | ||
}) | ||
public class ExpiredJKSTrustStoreTest { | ||
|
||
private static final String configuration = """ | ||
# Server | ||
quarkus.tls.key-store.jks.path=target/certs/expired-test-formats-keystore.jks | ||
quarkus.tls.key-store.jks.password=password | ||
# Clients | ||
quarkus.tls.warn.trust-store.jks.path=target/certs/expired-test-formats-truststore.jks | ||
quarkus.tls.warn.trust-store.jks.password=password | ||
quarkus.tls.warn.trust-store.certificate-expiration-policy=warn | ||
quarkus.tls.reject.trust-store.jks.path=target/certs/expired-test-formats-truststore.jks | ||
quarkus.tls.reject.trust-store.jks.password=password | ||
quarkus.tls.reject.trust-store.certificate-expiration-policy=reject | ||
"""; | ||
|
||
@RegisterExtension | ||
static final QuarkusUnitTest config = new QuarkusUnitTest().setArchiveProducer( | ||
() -> ShrinkWrap.create(JavaArchive.class) | ||
.add(new StringAsset(configuration), "application.properties")); | ||
|
||
@Inject | ||
TlsConfigurationRegistry certificates; | ||
|
||
@Inject | ||
Vertx vertx; | ||
|
||
@Test | ||
void testWarn() throws InterruptedException { | ||
TlsConfiguration cf = certificates.get("warn").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
CountDownLatch latch = new CountDownLatch(1); | ||
client.get(8081, "localhost", "/").send(ar -> { | ||
assertThat(ar.succeeded()).isTrue(); | ||
assertThat(ar.result().bodyAsString()).isEqualTo("Hello"); | ||
latch.countDown(); | ||
}); | ||
|
||
assertThat(latch.await(10, java.util.concurrent.TimeUnit.SECONDS)).isTrue(); | ||
} | ||
|
||
@Test | ||
void testReject() { | ||
TlsConfiguration cf = certificates.get("reject").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
assertThatThrownBy(() -> client.get(8081, "localhost", "/") | ||
.send().toCompletionStage().toCompletableFuture().join()).hasCauseInstanceOf(SSLHandshakeException.class); | ||
} | ||
} |
100 changes: 100 additions & 0 deletions
100
...nsions/tls-registry/deployment/src/test/java/io/quarkus/tls/ExpiredP12TrustStoreTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
package io.quarkus.tls; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
||
import java.util.concurrent.CountDownLatch; | ||
|
||
import javax.net.ssl.SSLHandshakeException; | ||
|
||
import jakarta.inject.Inject; | ||
|
||
import org.jboss.shrinkwrap.api.ShrinkWrap; | ||
import org.jboss.shrinkwrap.api.asset.StringAsset; | ||
import org.jboss.shrinkwrap.api.spec.JavaArchive; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
||
import io.quarkus.test.QuarkusUnitTest; | ||
import io.smallrye.certs.Format; | ||
import io.smallrye.certs.junit5.Certificate; | ||
import io.smallrye.certs.junit5.Certificates; | ||
import io.vertx.core.Vertx; | ||
import io.vertx.core.http.HttpServerOptions; | ||
import io.vertx.ext.web.client.WebClient; | ||
import io.vertx.ext.web.client.WebClientOptions; | ||
|
||
@Certificates(baseDir = "target/certs", certificates = { | ||
@Certificate(name = "expired-test-formats", password = "password", formats = { Format.JKS, Format.PEM, | ||
Format.PKCS12 }, duration = -5) | ||
}) | ||
public class ExpiredP12TrustStoreTest { | ||
|
||
private static final String configuration = """ | ||
# Server | ||
quarkus.tls.key-store.p12.path=target/certs/expired-test-formats-keystore.p12 | ||
quarkus.tls.key-store.p12.password=password | ||
# Clients | ||
quarkus.tls.warn.trust-store.p12.path=target/certs/expired-test-formats-truststore.p12 | ||
quarkus.tls.warn.trust-store.p12.password=password | ||
quarkus.tls.warn.trust-store.certificate-expiration-policy=warn | ||
quarkus.tls.reject.trust-store.p12.path=target/certs/expired-test-formats-truststore.p12 | ||
quarkus.tls.reject.trust-store.p12.password=password | ||
quarkus.tls.reject.trust-store.certificate-expiration-policy=reject | ||
"""; | ||
|
||
@RegisterExtension | ||
static final QuarkusUnitTest config = new QuarkusUnitTest().setArchiveProducer( | ||
() -> ShrinkWrap.create(JavaArchive.class) | ||
.add(new StringAsset(configuration), "application.properties")); | ||
|
||
@Inject | ||
TlsConfigurationRegistry certificates; | ||
|
||
@Inject | ||
Vertx vertx; | ||
|
||
@Test | ||
void testWarn() throws InterruptedException { | ||
TlsConfiguration cf = certificates.get("warn").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
CountDownLatch latch = new CountDownLatch(1); | ||
client.get(8081, "localhost", "/").send(ar -> { | ||
assertThat(ar.succeeded()).isTrue(); | ||
assertThat(ar.result().bodyAsString()).isEqualTo("Hello"); | ||
latch.countDown(); | ||
}); | ||
|
||
assertThat(latch.await(10, java.util.concurrent.TimeUnit.SECONDS)).isTrue(); | ||
} | ||
|
||
@Test | ||
void testReject() { | ||
TlsConfiguration cf = certificates.get("reject").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
assertThatThrownBy(() -> client.get(8081, "localhost", "/") | ||
.send().toCompletionStage().toCompletableFuture().join()).hasCauseInstanceOf(SSLHandshakeException.class); | ||
} | ||
} |
98 changes: 98 additions & 0 deletions
98
...nsions/tls-registry/deployment/src/test/java/io/quarkus/tls/ExpiredPemTrustStoreTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
package io.quarkus.tls; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
||
import java.util.concurrent.CountDownLatch; | ||
|
||
import javax.net.ssl.SSLHandshakeException; | ||
|
||
import jakarta.inject.Inject; | ||
|
||
import org.jboss.shrinkwrap.api.ShrinkWrap; | ||
import org.jboss.shrinkwrap.api.asset.StringAsset; | ||
import org.jboss.shrinkwrap.api.spec.JavaArchive; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
||
import io.quarkus.test.QuarkusUnitTest; | ||
import io.smallrye.certs.Format; | ||
import io.smallrye.certs.junit5.Certificate; | ||
import io.smallrye.certs.junit5.Certificates; | ||
import io.vertx.core.Vertx; | ||
import io.vertx.core.http.HttpServerOptions; | ||
import io.vertx.ext.web.client.WebClient; | ||
import io.vertx.ext.web.client.WebClientOptions; | ||
|
||
@Certificates(baseDir = "target/certs", certificates = { | ||
@Certificate(name = "expired-test-formats", password = "password", formats = { Format.JKS, Format.PEM, | ||
Format.PKCS12 }, duration = -5) | ||
}) | ||
public class ExpiredPemTrustStoreTest { | ||
|
||
private static final String configuration = """ | ||
# Server | ||
quarkus.tls.key-store.p12.path=target/certs/expired-test-formats-keystore.p12 | ||
quarkus.tls.key-store.p12.password=password | ||
# Clients | ||
quarkus.tls.warn.trust-store.pem.certs=target/certs/expired-test-formats.crt | ||
quarkus.tls.warn.trust-store.certificate-expiration-policy=warn | ||
quarkus.tls.reject.trust-store.pem.certs=target/certs/expired-test-formats.crt | ||
quarkus.tls.reject.trust-store.certificate-expiration-policy=reject | ||
"""; | ||
|
||
@RegisterExtension | ||
static final QuarkusUnitTest config = new QuarkusUnitTest().setArchiveProducer( | ||
() -> ShrinkWrap.create(JavaArchive.class) | ||
.add(new StringAsset(configuration), "application.properties")); | ||
|
||
@Inject | ||
TlsConfigurationRegistry certificates; | ||
|
||
@Inject | ||
Vertx vertx; | ||
|
||
@Test | ||
void testWarn() throws InterruptedException { | ||
TlsConfiguration cf = certificates.get("warn").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
CountDownLatch latch = new CountDownLatch(1); | ||
client.get(8081, "localhost", "/").send(ar -> { | ||
assertThat(ar.succeeded()).isTrue(); | ||
assertThat(ar.result().bodyAsString()).isEqualTo("Hello"); | ||
latch.countDown(); | ||
}); | ||
|
||
assertThat(latch.await(10, java.util.concurrent.TimeUnit.SECONDS)).isTrue(); | ||
} | ||
|
||
@Test | ||
void testReject() { | ||
TlsConfiguration cf = certificates.get("reject").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
assertThatThrownBy(() -> client.get(8081, "localhost", "/") | ||
.send().toCompletionStage().toCompletableFuture().join()).hasCauseInstanceOf(SSLHandshakeException.class); | ||
} | ||
} |
87 changes: 87 additions & 0 deletions
87
...loyment/src/test/java/io/quarkus/tls/ExpiredTrustStoreWithMTLSAndServerRejectionTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
package io.quarkus.tls; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
||
import jakarta.inject.Inject; | ||
|
||
import org.jboss.shrinkwrap.api.ShrinkWrap; | ||
import org.jboss.shrinkwrap.api.asset.StringAsset; | ||
import org.jboss.shrinkwrap.api.spec.JavaArchive; | ||
import org.junit.jupiter.api.AfterEach; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
||
import io.quarkus.test.QuarkusUnitTest; | ||
import io.smallrye.certs.Format; | ||
import io.smallrye.certs.junit5.Certificate; | ||
import io.smallrye.certs.junit5.Certificates; | ||
import io.vertx.core.Vertx; | ||
import io.vertx.core.http.ClientAuth; | ||
import io.vertx.core.http.HttpServer; | ||
import io.vertx.core.http.HttpServerOptions; | ||
import io.vertx.ext.web.client.WebClient; | ||
import io.vertx.ext.web.client.WebClientOptions; | ||
|
||
@Certificates(baseDir = "target/certs", certificates = { | ||
@Certificate(name = "expired-mtls", password = "password", formats = { Format.PKCS12 }, duration = -5, client = true) | ||
}) | ||
public class ExpiredTrustStoreWithMTLSAndServerRejectionTest { | ||
|
||
private static final String configuration = """ | ||
# Server | ||
quarkus.tls.key-store.p12.path=target/certs/expired-mtls-keystore.p12 | ||
quarkus.tls.key-store.p12.password=password | ||
quarkus.tls.trust-store.p12.path=target/certs/expired-mtls-server-truststore.p12 | ||
quarkus.tls.trust-store.p12.password=password | ||
quarkus.tls.trust-store.certificate-expiration-policy=reject | ||
# Client | ||
quarkus.tls.warn.trust-store.p12.path=target/certs/expired-mtls-client-truststore.p12 | ||
quarkus.tls.warn.trust-store.p12.password=password | ||
quarkus.tls.warn.trust-store.certificate-expiration-policy=ignore | ||
quarkus.tls.warn.key-store.p12.path=target/certs/expired-mtls-client-keystore.p12 | ||
quarkus.tls.warn.key-store.p12.password=password | ||
"""; | ||
|
||
@RegisterExtension | ||
static final QuarkusUnitTest config = new QuarkusUnitTest().setArchiveProducer( | ||
() -> ShrinkWrap.create(JavaArchive.class) | ||
.add(new StringAsset(configuration), "application.properties")); | ||
|
||
@Inject | ||
TlsConfigurationRegistry certificates; | ||
|
||
@Inject | ||
Vertx vertx; | ||
|
||
private HttpServer server; | ||
|
||
@AfterEach | ||
void cleanup() { | ||
if (server != null) { | ||
server.close().toCompletionStage().toCompletableFuture().join(); | ||
} | ||
} | ||
|
||
@Test | ||
void testServerRejection() throws InterruptedException { | ||
TlsConfiguration cf = certificates.get("warn").orElseThrow(); | ||
assertThat(cf.getTrustStoreOptions()).isNotNull(); | ||
|
||
WebClient client = WebClient.create(vertx, new WebClientOptions() | ||
.setSsl(true) | ||
.setKeyCertOptions(cf.getKeyStoreOptions()) | ||
.setTrustOptions(cf.getTrustStoreOptions())); | ||
|
||
server = vertx.createHttpServer(new HttpServerOptions() | ||
.setSsl(true) | ||
.setClientAuth(ClientAuth.REQUIRED) | ||
.setTrustOptions(certificates.getDefault().orElseThrow().getTrustStoreOptions()) | ||
.setKeyCertOptions(certificates.getDefault().orElseThrow().getKeyStoreOptions())) | ||
.requestHandler(rc -> rc.response().end("Hello")).listen(8081).toCompletionStage().toCompletableFuture().join(); | ||
|
||
assertThatThrownBy(() -> client.get(8081, "localhost", "/").send().toCompletionStage().toCompletableFuture().join()) | ||
.hasMessageContaining("SSLHandshakeException"); | ||
} | ||
} |
Oops, something went wrong.