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

Enable vertx-websocket extension to handle Quarkus TLS Registry configuration #6420

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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
*/
package org.apache.camel.quarkus.component.vertx.websocket.deployment;

import io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.annotations.Consume;
import io.quarkus.deployment.annotations.ExecutionTime;
import io.quarkus.deployment.annotations.Record;
import io.quarkus.deployment.builditem.FeatureBuildItem;
Expand All @@ -38,6 +40,7 @@ FeatureBuildItem feature() {
}

@BuildStep
@Consume(SyntheticBeansRuntimeInitBuildItem.class)
@Record(ExecutionTime.RUNTIME_INIT)
CamelRuntimeBeanBuildItem configureVertxWebsocketComponent(
VertxBuildItem vertx,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,15 @@
package org.apache.camel.quarkus.component.vertx.websocket;

import java.net.URI;
import java.util.Optional;
import java.util.concurrent.ExecutionException;

import io.quarkus.arc.Arc;
import io.quarkus.runtime.LaunchMode;
import io.quarkus.runtime.RuntimeValue;
import io.quarkus.runtime.annotations.Recorder;
import io.quarkus.tls.TlsConfiguration;
import io.quarkus.tls.TlsConfigurationRegistry;
import io.quarkus.vertx.http.runtime.CertificateConfig;
import io.quarkus.vertx.http.runtime.HttpConfiguration;
import io.quarkus.vertx.http.runtime.ServerSslConfig;
Expand Down Expand Up @@ -51,24 +55,10 @@ public RuntimeValue<VertxWebsocketComponent> createVertxWebsocketComponent(
LaunchMode launchMode,
HttpConfiguration httpConfig) {

boolean sslEnabled = false;
boolean sslEnabled = isHttpSeverSecureTransportConfigured(httpConfig);
int httpPort = httpConfig.determinePort(launchMode);
int httpsPort = httpConfig.determineSslPort(launchMode);

ServerSslConfig ssl = httpConfig.ssl;
if (ssl != null) {
CertificateConfig certificate = ssl.certificate;
if (certificate != null) {
if (certificate.files.isPresent() && certificate.keyFiles.isPresent()) {
sslEnabled = true;
}

if (certificate.keyStoreFile.isPresent() && certificate.keyStorePassword.isPresent()) {
sslEnabled = true;
}
}
}

HOST = httpConfig.host;
PORT = sslEnabled ? httpsPort : httpPort;

Expand All @@ -80,6 +70,40 @@ public RuntimeValue<VertxWebsocketComponent> createVertxWebsocketComponent(
return new RuntimeValue<>(component);
}

private boolean isHttpSeverSecureTransportConfigured(HttpConfiguration httpConfig) {
return httpServerTlsRegistryConfigurationExists(httpConfig) || httpServerLegacySslConfigurationExists(httpConfig);
}

private boolean httpServerTlsRegistryConfigurationExists(HttpConfiguration httpConfig) {
if (Arc.container() != null) {
TlsConfigurationRegistry tlsConfigurationRegistry = Arc.container().select(TlsConfigurationRegistry.class).orNull();
if (tlsConfigurationRegistry != null) {
Optional<String> tlsConfigurationName = httpConfig.tlsConfigurationName;
Optional<TlsConfiguration> defaultTlsConfiguration = tlsConfigurationRegistry.getDefault();
if (tlsConfigurationName.isPresent() && tlsConfigurationRegistry.get(tlsConfigurationName.get()).isPresent()) {
return true;
} else {
return defaultTlsConfiguration.isPresent() && defaultTlsConfiguration.get().getKeyStoreOptions() != null;
}
}
}
return false;
}

private boolean httpServerLegacySslConfigurationExists(HttpConfiguration httpConfig) {
ServerSslConfig ssl = httpConfig.ssl;
if (ssl != null) {
CertificateConfig certificate = ssl.certificate;
if (certificate != null) {
if (certificate.files.isPresent() && certificate.keyFiles.isPresent()) {
return true;
}
return certificate.keyStoreFile.isPresent() && certificate.keyStorePassword.isPresent();
}
}
return false;
}

@Component("vertx-websocket")
static final class QuarkusVertxWebsocketComponent extends VertxWebsocketComponent {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,9 @@
*/
package org.apache.camel.quarkus.component.vertx.websocket.it;

import java.util.Map;
import io.quarkus.test.junit.QuarkusIntegrationTest;

import io.quarkus.test.junit.QuarkusTestProfile;
@QuarkusIntegrationTest
class VertxWebsocketLegacySslIT extends VertxWebsocketLegacySslTest {

public class VertxWebsocketSslTestProfile implements QuarkusTestProfile {

@Override
public Map<String, String> getConfigOverrides() {
return Map.of(
"quarkus.http.ssl.certificate.files", "target/certs/vertx-websocket.crt",
"quarkus.http.ssl.certificate.key-files", "target/certs/vertx-websocket.key",
"quarkus.http.insecure-requests", "disabled");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.quarkus.component.vertx.websocket.it;

import java.util.Map;

import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.QuarkusTestProfile;
import io.quarkus.test.junit.TestProfile;
import me.escoffier.certs.Format;
import me.escoffier.certs.junit5.Certificate;
import org.apache.camel.quarkus.test.support.certificate.TestCertificates;

@TestCertificates(certificates = {
@Certificate(name = "vertx-websocket", formats = {
Format.PKCS12, Format.PEM }, password = "changeit") })
@TestProfile(VertxWebsocketLegacySslTest.VertxWebsocketLegacySslTestProfile.class)
@QuarkusTest
class VertxWebsocketLegacySslTest extends VertxWebsocketSslTest {
public static class VertxWebsocketLegacySslTestProfile implements QuarkusTestProfile {
@Override
public Map<String, String> getConfigOverrides() {
return Map.of(
"quarkus.http.ssl.certificate.files", "target/certs/vertx-websocket.crt",
"quarkus.http.ssl.certificate.key-files", "target/certs/vertx-websocket.key",
"quarkus.http.insecure-requests", "disabled");
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,15 @@
import java.util.List;

import io.quarkus.test.common.http.TestHTTPResource;
import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.TestProfile;
import io.restassured.RestAssured;
import me.escoffier.certs.Format;
import me.escoffier.certs.junit5.Certificate;
import org.apache.camel.quarkus.test.support.certificate.TestCertificates;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

import static org.hamcrest.Matchers.matchesPattern;
import static org.junit.jupiter.api.Assertions.assertEquals;

@TestCertificates(certificates = {
@Certificate(name = "vertx-websocket", formats = {
Format.PKCS12, Format.PEM }, password = "changeit") })
@TestProfile(VertxWebsocketSslTestProfile.class)
@QuarkusTest
public class VertxWebsocketSslTest {
@TestHTTPResource(value = "/", ssl = true)
public abstract class VertxWebsocketSslTest {
@TestHTTPResource(value = "/", tls = true)
URI root;

@BeforeAll
Expand All @@ -50,6 +41,14 @@ public void ssl() throws Exception {
URI uri = URI.create(root.toString().replace("https", "wss"));
String message = "SSL Vert.x WebSocket Route";

RestAssured.given()
.queryParam("hostPort", "localhost:8441")
.get("/vertx-websocket/invalid/consumer/uri")
.then()
.statusCode(500)
.body(matchesPattern(
"Invalid host/port localhost:8441.*can only be configured as (localhost|0.0.0.0):" + uri.getPort()));

try (VertxWebsocketTest.WebSocketConnection connection = new VertxWebsocketTest.WebSocketConnection(uri, null)) {
connection.connect();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.junit.jupiter.params.provider.ValueSource;

import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.matchesPattern;
import static org.hamcrest.Matchers.startsWith;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
Expand Down Expand Up @@ -88,7 +89,8 @@ public void testInvalidHostPortConfig(String hostPort) throws Exception {
.get("/vertx-websocket/invalid/consumer/uri")
.then()
.statusCode(500)
.body(startsWith("Invalid host/port"));
.body(matchesPattern(
"Invalid host/port " + hostPort + ".*can only be configured as (localhost|0.0.0.0):" + root.getPort()));
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@
import io.quarkus.test.junit.QuarkusIntegrationTest;

@QuarkusIntegrationTest
class VertxWebsocketSslIT extends VertxWebsocketSslTest {
class VertxWebsocketTlsIT extends VertxWebsocketTlsTest {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.quarkus.component.vertx.websocket.it;

import io.quarkus.test.junit.QuarkusIntegrationTest;

@QuarkusIntegrationTest
class VertxWebsocketTlsNamedConfigIT extends VertxWebsocketTlsNamedConfigTest {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.quarkus.component.vertx.websocket.it;

import java.util.Map;

import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.QuarkusTestProfile;
import io.quarkus.test.junit.TestProfile;
import me.escoffier.certs.Format;
import me.escoffier.certs.junit5.Certificate;
import org.apache.camel.quarkus.test.support.certificate.TestCertificates;

@TestCertificates(certificates = {
@Certificate(name = "vertx-websocket", formats = {
Format.PKCS12, Format.PEM }, password = "changeit") })
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we use the PKCS12 format somewhere? I see just the PEM one being used below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TestProfile(VertxWebsocketTlsNamedConfigTest.VertxWebsocketTlsNamedConfigTestProfile.class)
@QuarkusTest
class VertxWebsocketTlsNamedConfigTest extends VertxWebsocketSslTest {
public static class VertxWebsocketTlsNamedConfigTestProfile implements QuarkusTestProfile {
@Override
public Map<String, String> getConfigOverrides() {
return Map.of(
"quarkus.tls.https.key-store.pem.0.cert", "target/certs/vertx-websocket.crt",
"quarkus.tls.https.key-store.pem.0.key", "target/certs/vertx-websocket.key",
"quarkus.http.insecure-requests", "disabled",
"quarkus.http.tls-configuration-name", "https");
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.quarkus.component.vertx.websocket.it;

import java.util.Map;

import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.QuarkusTestProfile;
import io.quarkus.test.junit.TestProfile;
import me.escoffier.certs.Format;
import me.escoffier.certs.junit5.Certificate;
import org.apache.camel.quarkus.test.support.certificate.TestCertificates;

@TestCertificates(certificates = {
@Certificate(name = "vertx-websocket", formats = {
Format.PKCS12, Format.PEM }, password = "changeit") })
@TestProfile(VertxWebsocketTlsTest.VertxWebsocketTlsTestProfile.class)
@QuarkusTest
class VertxWebsocketTlsTest extends VertxWebsocketSslTest {
public static class VertxWebsocketTlsTestProfile implements QuarkusTestProfile {
@Override
public Map<String, String> getConfigOverrides() {
return Map.of(
"quarkus.tls.key-store.pem.0.cert", "target/certs/vertx-websocket.crt",
"quarkus.tls.key-store.pem.0.key", "target/certs/vertx-websocket.key",
"quarkus.http.insecure-requests", "disabled");
}
}
}