-
-
Notifications
You must be signed in to change notification settings - Fork 429
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[websocket] Allow registering websocket adapters (#3622)
* [WebSocket] Allow register websocket handlers Signed-off-by: Miguel Álvarez <miguelwork92@gmail.com>
- Loading branch information
Showing
13 changed files
with
449 additions
and
216 deletions.
There are no files selected for viewing
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
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
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
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
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
136 changes: 136 additions & 0 deletions
136
...core.io.websocket/src/main/java/org/openhab/core/io/websocket/CommonWebSocketServlet.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,136 @@ | ||
| /** | ||
| * Copyright (c) 2010-2023 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.core.io.websocket; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import javax.servlet.Servlet; | ||
| import javax.servlet.ServletException; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.jetty.websocket.server.WebSocketServerFactory; | ||
| import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest; | ||
| import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse; | ||
| import org.eclipse.jetty.websocket.servlet.WebSocketCreator; | ||
| import org.eclipse.jetty.websocket.servlet.WebSocketServlet; | ||
| import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory; | ||
| import org.openhab.core.auth.AuthenticationException; | ||
| import org.openhab.core.auth.Role; | ||
| import org.openhab.core.io.rest.auth.AuthFilter; | ||
| import org.osgi.service.component.annotations.Activate; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Reference; | ||
| import org.osgi.service.component.annotations.ReferenceCardinality; | ||
| import org.osgi.service.component.annotations.ReferencePolicy; | ||
| import org.osgi.service.http.NamespaceException; | ||
| import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName; | ||
| import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * The {@link CommonWebSocketServlet} provides the servlet for WebSocket connections | ||
| * | ||
| * @author Jan N. Klug - Initial contribution | ||
| * @author Miguel Álvarez Díez - Refactor into a common servlet | ||
| */ | ||
| @NonNullByDefault | ||
| @HttpWhiteboardServletName(CommonWebSocketServlet.SERVLET_PATH) | ||
| @HttpWhiteboardServletPattern(CommonWebSocketServlet.SERVLET_PATH + "/*") | ||
| @Component(immediate = true, service = { Servlet.class }) | ||
| public class CommonWebSocketServlet extends WebSocketServlet { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| public static final String SERVLET_PATH = "/ws"; | ||
|
|
||
| public static final String DEFAULT_ADAPTER_ID = EventWebSocketAdapter.ADAPTER_ID; | ||
|
|
||
| private final Map<String, WebSocketAdapter> connectionHandlers = new HashMap<>(); | ||
| private final AuthFilter authFilter; | ||
|
|
||
| @SuppressWarnings("unused") | ||
| private @Nullable WebSocketServerFactory importNeeded; | ||
|
|
||
| @Activate | ||
| public CommonWebSocketServlet(@Reference AuthFilter authFilter) throws ServletException, NamespaceException { | ||
| this.authFilter = authFilter; | ||
| } | ||
|
|
||
| @Override | ||
| public void configure(@NonNullByDefault({}) WebSocketServletFactory webSocketServletFactory) { | ||
| webSocketServletFactory.getPolicy().setIdleTimeout(10000); | ||
| webSocketServletFactory.setCreator(new CommonWebSocketCreator()); | ||
| } | ||
|
|
||
| @Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC) | ||
| protected void addWebSocketAdapter(WebSocketAdapter wsAdapter) { | ||
| this.connectionHandlers.put(wsAdapter.getId(), wsAdapter); | ||
| } | ||
|
|
||
| protected void removeWebSocketAdapter(WebSocketAdapter wsAdapter) { | ||
| this.connectionHandlers.remove(wsAdapter.getId()); | ||
| } | ||
|
|
||
| private class CommonWebSocketCreator implements WebSocketCreator { | ||
| private final Logger logger = LoggerFactory.getLogger(CommonWebSocketCreator.class); | ||
|
|
||
| @Override | ||
| public @Nullable Object createWebSocket(@Nullable ServletUpgradeRequest servletUpgradeRequest, | ||
| @Nullable ServletUpgradeResponse servletUpgradeResponse) { | ||
| if (servletUpgradeRequest == null || servletUpgradeResponse == null) { | ||
| return null; | ||
| } | ||
| if (isAuthorizedRequest(servletUpgradeRequest)) { | ||
| String requestPath = servletUpgradeRequest.getRequestURI().getPath(); | ||
| String pathPrefix = SERVLET_PATH + "/"; | ||
| boolean useDefaultAdapter = requestPath.equals(pathPrefix) || !requestPath.startsWith(pathPrefix); | ||
| WebSocketAdapter wsAdapter; | ||
| if (!useDefaultAdapter) { | ||
| String adapterId = requestPath.substring(pathPrefix.length()); | ||
| wsAdapter = connectionHandlers.get(adapterId); | ||
| if (wsAdapter == null) { | ||
| logger.warn("Missing WebSocket adapter for path {}", adapterId); | ||
| return null; | ||
| } | ||
| } else { | ||
| wsAdapter = connectionHandlers.get(DEFAULT_ADAPTER_ID); | ||
| if (wsAdapter == null) { | ||
| logger.warn("Default WebSocket adapter is missing"); | ||
| return null; | ||
| } | ||
| } | ||
| logger.debug("New connection handled by {}", wsAdapter.getId()); | ||
| return wsAdapter.createWebSocket(servletUpgradeRequest, servletUpgradeResponse); | ||
| } else { | ||
| logger.warn("Unauthenticated request to create a websocket from {}.", | ||
| servletUpgradeRequest.getRemoteAddress()); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private boolean isAuthorizedRequest(ServletUpgradeRequest servletUpgradeRequest) { | ||
| try { | ||
| var securityContext = authFilter.getSecurityContext(servletUpgradeRequest.getHttpServletRequest(), | ||
| true); | ||
| return securityContext != null | ||
| && (securityContext.isUserInRole(Role.USER) || securityContext.isUserInRole(Role.ADMIN)); | ||
| } catch (AuthenticationException | IOException e) { | ||
| logger.warn("Error handling WebSocket authorization", e); | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.