org.apache.pulsar.websocket.AbstractWebSocketHandler Maven / Gradle / Ivy
/**
* 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.pulsar.websocket;
import com.google.common.base.Splitter;
import org.apache.commons.lang3.StringUtils;
import org.apache.pulsar.broker.authentication.AuthenticationDataHttps;
import org.apache.pulsar.broker.authentication.AuthenticationDataSource;
import org.apache.pulsar.common.naming.NamespaceName;
import org.apache.pulsar.common.naming.TopicName;
import org.apache.pulsar.common.util.Codec;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.api.WebSocketAdapter;
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.naming.AuthenticationException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.Closeable;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import static com.google.common.base.Preconditions.checkArgument;
public abstract class AbstractWebSocketHandler extends WebSocketAdapter implements Closeable {
protected final WebSocketService service;
protected final HttpServletRequest request;
protected final TopicName topic;
protected final Map queryParams;
public AbstractWebSocketHandler(WebSocketService service, HttpServletRequest request, ServletUpgradeResponse response) {
this.service = service;
this.request = new WebSocketHttpServletRequestWrapper(request);
this.topic = extractTopicName(request);
this.queryParams = new TreeMap<>();
request.getParameterMap().forEach((key, values) -> {
queryParams.put(key, values[0]);
});
}
protected boolean checkAuth(ServletUpgradeResponse response) {
String authRole = "";
if (service.isAuthenticationEnabled()) {
try {
authRole = service.getAuthenticationService().authenticateHttpRequest(request);
log.info("[{}:{}] Authenticated WebSocket client {} on topic {}", request.getRemoteAddr(),
request.getRemotePort(), authRole, topic);
} catch (AuthenticationException e) {
log.warn("[{}:{}] Failed to authenticated WebSocket client {} on topic {}: {}", request.getRemoteAddr(),
request.getRemotePort(), authRole, topic, e.getMessage());
try {
response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Failed to authenticate");
} catch (IOException e1) {
log.warn("[{}:{}] Failed to send error: {}", request.getRemoteAddr(), request.getRemotePort(),
e1.getMessage(), e1);
}
return false;
}
}
if (service.isAuthorizationEnabled()) {
AuthenticationDataSource authenticationData = new AuthenticationDataHttps(request);
try {
if (!isAuthorized(authRole, authenticationData)) {
log.warn("[{}:{}] WebSocket Client [{}] is not authorized on topic {}", request.getRemoteAddr(),
request.getRemotePort(), authRole, topic);
response.sendError(HttpServletResponse.SC_FORBIDDEN, "Not authorized");
return false;
}
} catch (Exception e) {
log.warn("[{}:{}] Got an exception when authorizing WebSocket client {} on topic {} on: {}",
request.getRemoteAddr(), request.getRemotePort(), authRole, topic, e.getMessage());
try {
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Server error");
} catch (IOException e1) {
log.warn("[{}:{}] Failed to send error: {}", request.getRemoteAddr(), request.getRemotePort(),
e1.getMessage(), e1);
}
return false;
}
}
return true;
}
@Override
public void onWebSocketConnect(Session session) {
super.onWebSocketConnect(session);
log.info("[{}] New WebSocket session on topic {}", session.getRemoteAddress(), topic);
}
@Override
public void onWebSocketError(Throwable cause) {
super.onWebSocketError(cause);
log.info("[{}] WebSocket error on topic {} : {}", getSession().getRemoteAddress(), topic, cause.getMessage());
try {
close();
} catch (IOException e) {
log.error("Failed in closing WebSocket session for topic {} with error: {}", topic, e.getMessage());
}
}
@Override
public void onWebSocketClose(int statusCode, String reason) {
log.info("[{}] Closed WebSocket session on topic {}. status: {} - reason: {}", getSession().getRemoteAddress(),
topic, statusCode, reason);
try {
close();
} catch (IOException e) {
log.warn("[{}] Failed to close handler for topic {}. ", getSession().getRemoteAddress(), topic, e);
}
}
public void close(WebSocketError error) {
log.warn("[{}] Closing WebSocket session for topic {} - code: [{}], reason: [{}]",
getSession().getRemoteAddress(), topic, error.getCode(), error.getDescription());
getSession().close(error.getCode(), error.getDescription());
}
public void close(WebSocketError error, String message) {
log.warn("[{}] Closing WebSocket session for topic {} - code: [{}], reason: [{}]",
getSession().getRemoteAddress(), topic, error.getCode(), error.getDescription() + ": " + message);
getSession().close(error.getCode(), error.getDescription() + ": " + message);
}
protected String checkAuthentication() {
return null;
}
private TopicName extractTopicName(HttpServletRequest request) {
String uri = request.getRequestURI();
List parts = Splitter.on("/").splitToList(uri);
// V1 Format must be like :
// /ws/producer/persistent/my-property/my-cluster/my-ns/my-topic
// or
// /ws/consumer/persistent/my-property/my-cluster/my-ns/my-topic/my-subscription
// or
// /ws/reader/persistent/my-property/my-cluster/my-ns/my-topic
// V2 Format must be like :
// /ws/v2/producer/persistent/my-property/my-ns/my-topic
// or
// /ws/v2/consumer/persistent/my-property/my-ns/my-topic/my-subscription
// or
// /ws/v2/reader/persistent/my-property/my-ns/my-topic
checkArgument(parts.size() >= 8, "Invalid topic name format");
checkArgument(parts.get(1).equals("ws"));
final boolean isV2Format = parts.get(2).equals("v2");
final int domainIndex = isV2Format ? 4 : 3;
checkArgument(parts.get(domainIndex).equals("persistent") ||
parts.get(domainIndex).equals("non-persistent"));
final String domain = parts.get(domainIndex);
final NamespaceName namespace = isV2Format ? NamespaceName.get(parts.get(5), parts.get(6)) :
NamespaceName.get( parts.get(4), parts.get(5), parts.get(6));
//The topic name which contains slashes is also split ， so it needs to be jointed
int startPosition = 7;
boolean isConsumer = "consumer".equals(parts.get(2)) || "consumer".equals(parts.get(3));
int endPosition = isConsumer ? parts.size() -1 : parts.size();
StringBuilder topicName = new StringBuilder(parts.get(startPosition));
while (++startPosition < endPosition) {
if(StringUtils.isEmpty(parts.get(startPosition))){
continue;
}
topicName.append("/").append(parts.get(startPosition));
}
final String name = Codec.decode(topicName.toString());
return TopicName.get(domain, namespace, name);
}
protected abstract Boolean isAuthorized(String authRole, AuthenticationDataSource authenticationData) throws Exception;
private static final Logger log = LoggerFactory.getLogger(AbstractWebSocketHandler.class);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy