Skip to content

[fix][broker] Fix potential OOM due to client use sasl authentication #20713

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

Merged
315157973 merged 7 commits into from
Jul 23, 2023
Merged

[fix][broker] Fix potential OOM due to client use sasl authentication #20713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9f3792e
[fix][broker] Fix potential OOM due to client use sasl authentication
315157973 Jul 4, 2023
44032c0
[fix][broker] Fix potential OOM due to client use sasl authentication
315157973 Jul 4, 2023
665ad96
fix test
315157973 Jul 4, 2023
e2686ca
Add unit test and address comment
315157973 Jul 4, 2023
60db04d
Add configuration item
315157973 Jul 19, 2023
9da80b8
Add max context limit
315157973 Jul 20, 2023
d56f491
Merge remote-tracking branch 'upstream/master' into oom
315157973 Jul 20, 2023
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
14 changes: 9 additions & 5 deletions ...asl/src/main/java/org/apache/pulsar/broker/authentication/AuthenticationProviderSasl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import static org.apache.pulsar.common.sasl.SaslConstants.SASL_STATE_NEGOTIATE;
import static org.apache.pulsar.common.sasl.SaslConstants.SASL_STATE_SERVER;
import static org.apache.pulsar.common.sasl.SaslConstants.SASL_STATE_SERVER_CHECK_TOKEN;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine;
import java.io.IOException;
import java.net.SocketAddress;
import java.net.URI;
Expand All @@ -41,7 +43,7 @@
import java.util.Base64;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import javax.naming.AuthenticationException;
Expand Down Expand Up @@ -72,6 +74,7 @@ public class AuthenticationProviderSasl implements AuthenticationProvider {

private JAASCredentialsContainer jaasCredentialsContainer;
private String loginContextName;
private Cache<Long, AuthenticationState> authStates;

@Override
public void initialize(ServiceConfiguration config) throws IOException {
Expand Down Expand Up @@ -110,6 +113,9 @@ public void initialize(ServiceConfiguration config) throws IOException {
throw new IllegalArgumentException(msg);
}
this.signer = new SaslRoleTokenSigner(secret);
this.authStates = Caffeine.newBuilder()
.maximumSize(config.getMaxInflightSaslContext())
.expireAfterWrite(config.getInflightSaslContextExpiryMs(), TimeUnit.MILLISECONDS).build();
}

@Override
Expand Down Expand Up @@ -198,8 +204,6 @@ private byte[] readSecretFromUrl(String secretConfUrl) throws IOException {
}
}

private ConcurrentHashMap<Long, AuthenticationState> authStates = new ConcurrentHashMap<>();

// return authState if it is in cache.
private AuthenticationState getAuthState(HttpServletRequest request) {
String id = request.getHeader(SASL_STATE_SERVER);
Expand All @@ -208,7 +212,7 @@ private AuthenticationState getAuthState(HttpServletRequest request) {
}

try {
return authStates.get(Long.parseLong(id));
return authStates.getIfPresent(Long.parseLong(id));
} catch (NumberFormatException e) {
log.error("[{}] Wrong Id String in Token {}. e:", request.getRequestURI(),
id, e);
Expand Down Expand Up @@ -295,7 +299,7 @@ public boolean authenticateHttpRequest(HttpServletRequest request, HttpServletRe
response.setStatus(HttpServletResponse.SC_OK);

// auth completed, no need to keep authState
authStates.remove(state.getStateId());
authStates.invalidate(state.getStateId());
return false;
} else {
// auth not complete
Expand Down
85 changes: 81 additions & 4 deletions ...auth-sasl/src/test/java/org/apache/pulsar/broker/authentication/SaslAuthenticateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,31 @@
*/
package org.apache.pulsar.broker.authentication;

import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertFalse;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertTrue;
import static org.testng.Assert.fail;

import com.github.benmanes.caffeine.cache.Cache;
import com.google.common.collect.ImmutableSet;
import java.io.File;
import java.io.FileWriter;
import java.lang.reflect.Field;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Base64;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import javax.security.auth.login.Configuration;

import com.google.common.collect.ImmutableSet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.apache.pulsar.client.admin.PulsarAdmin;
Expand All @@ -59,6 +64,7 @@
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import org.testng.collections.CollectionUtils;

@Slf4j
public class SaslAuthenticateTest extends ProducerConsumerBase {
Expand Down Expand Up @@ -295,4 +301,75 @@ public void testSaslServerAndClientAuth() throws Exception {
log.info("-- {} -- end", methodName);
}

@Test
public void testSaslOnlyAuthFirstStage() throws Exception {
AuthenticationProviderSasl saslServer = (AuthenticationProviderSasl) pulsar.getBrokerService()
.getAuthenticationService().getAuthenticationProvider(SaslConstants.AUTH_METHOD_NAME);

HttpServletRequest servletRequest = mock(HttpServletRequest.class);
doReturn("Init").when(servletRequest).getHeader("State");
// 10 clients only do one-stage verification, resulting in 10 auth info remaining in memory
for (int i = 0; i < 10; i++) {
AuthenticationDataProvider dataProvider = authSasl.getAuthData("localhost");
AuthData initData1 = dataProvider.authenticate(AuthData.INIT_AUTH_DATA);
doReturn(Base64.getEncoder().encodeToString(initData1.getBytes())).when(
servletRequest).getHeader("SASL-Token");
doReturn(String.valueOf(i)).when(servletRequest).getHeader("SASL-Server-ID");
saslServer.authenticateHttpRequest(servletRequest, mock(HttpServletResponse.class));
}
Field field = AuthenticationProviderSasl.class.getDeclaredField("authStates");
field.setAccessible(true);
Cache<Long, AuthenticationState> cache = (Cache<Long, AuthenticationState>) field.get(saslServer);
assertEquals(cache.asMap().size(), 10);
// The cache expiration time is set to 1ms. Residual auth info should be cleaned up
conf.setInflightSaslContextExpiryMs(1);
saslServer.initialize(conf);
// Add more auth info into memory
for (int i = 0; i < 10; i++) {
AuthenticationDataProvider dataProvider = authSasl.getAuthData("localhost");
AuthData initData1 = dataProvider.authenticate(AuthData.INIT_AUTH_DATA);
doReturn(Base64.getEncoder().encodeToString(initData1.getBytes())).when(
servletRequest).getHeader("SASL-Token");
doReturn(String.valueOf(10 + i)).when(servletRequest).getHeader("SASL-Server-ID");
saslServer.authenticateHttpRequest(servletRequest, mock(HttpServletResponse.class));
}
long start = System.currentTimeMillis();
while (true) {
if (System.currentTimeMillis() - start > 10_00) {
fail();
}
cache = (Cache<Long, AuthenticationState>) field.get(saslServer);
// Residual auth info should be cleaned up
if (CollectionUtils.hasElements(cache.asMap())) {
break;
}
Thread.yield();
}
}

@Test
public void testMaxInflightContext() throws Exception {
AuthenticationProviderSasl saslServer = (AuthenticationProviderSasl) pulsar.getBrokerService()
.getAuthenticationService().getAuthenticationProvider(SaslConstants.AUTH_METHOD_NAME);
HttpServletRequest servletRequest = mock(HttpServletRequest.class);
doReturn("Init").when(servletRequest).getHeader("State");
conf.setInflightSaslContextExpiryMs(Integer.MAX_VALUE);
conf.setMaxInflightSaslContext(1);
saslServer.initialize(conf);
// add 10 inflight sasl context
for (int i = 0; i < 10; i++) {
AuthenticationDataProvider dataProvider = authSasl.getAuthData("localhost");
AuthData initData1 = dataProvider.authenticate(AuthData.INIT_AUTH_DATA);
doReturn(Base64.getEncoder().encodeToString(initData1.getBytes())).when(
servletRequest).getHeader("SASL-Token");
doReturn(String.valueOf(i)).when(servletRequest).getHeader("SASL-Server-ID");
saslServer.authenticateHttpRequest(servletRequest, mock(HttpServletResponse.class));
}
Field field = AuthenticationProviderSasl.class.getDeclaredField("authStates");
field.setAccessible(true);
Cache<Long, AuthenticationState> cache = (Cache<Long, AuthenticationState>) field.get(saslServer);
//only 1 context was left in the memory
assertEquals(cache.asMap().size(), 1);
}

}
12 changes: 12 additions & 0 deletions pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1654,6 +1654,18 @@ The delayed message index time step(in seconds) in per bucket snapshot segment,
)
private String kinitCommand = "/usr/bin/kinit";

@FieldContext(
category = CATEGORY_SASL_AUTH,
doc = "how often the broker expires the inflight SASL context."
)
private long inflightSaslContextExpiryMs = 30_000L;

@FieldContext(
category = CATEGORY_SASL_AUTH,
doc = "Maximum number of inflight sasl context."
)
private long maxInflightSaslContext = 50_000L;

/**** --- BookKeeper Client. --- ****/
@FieldContext(
category = CATEGORY_STORAGE_BK,
Expand Down