mirror of
https://github.com/signalapp/Signal-Server
synced 2026-02-15 10:35:45 +00:00
Add an allow-list for gRPC methods
This commit is contained in:
@@ -31,6 +31,7 @@ import org.whispersystems.textsecuregcm.configuration.DeviceCheckConfiguration;
|
||||
import org.whispersystems.textsecuregcm.configuration.DirectoryV2Configuration;
|
||||
import org.whispersystems.textsecuregcm.configuration.DynamoDbClientFactory;
|
||||
import org.whispersystems.textsecuregcm.configuration.DynamoDbTables;
|
||||
import org.whispersystems.textsecuregcm.configuration.GrpcAllowListConfiguration;
|
||||
import org.whispersystems.textsecuregcm.configuration.ExternalRequestFilterConfiguration;
|
||||
import org.whispersystems.textsecuregcm.configuration.FaultTolerantRedisClientFactory;
|
||||
import org.whispersystems.textsecuregcm.configuration.FaultTolerantRedisClusterFactory;
|
||||
@@ -348,6 +349,11 @@ public class WhisperServerConfiguration extends Configuration {
|
||||
@JsonProperty
|
||||
private GrpcConfiguration grpc;
|
||||
|
||||
@NotNull
|
||||
@Valid
|
||||
@JsonProperty
|
||||
private GrpcAllowListConfiguration grpcAllowList = new GrpcAllowListConfiguration();
|
||||
|
||||
@Valid
|
||||
@NotNull
|
||||
@JsonProperty
|
||||
@@ -589,6 +595,10 @@ public class WhisperServerConfiguration extends Configuration {
|
||||
return grpc;
|
||||
}
|
||||
|
||||
public GrpcAllowListConfiguration getGrpcAllowList() {
|
||||
return grpcAllowList;
|
||||
}
|
||||
|
||||
public S3ObjectMonitorFactory getAsnTableConfiguration() {
|
||||
return asnTable;
|
||||
}
|
||||
|
||||
@@ -143,6 +143,7 @@ import org.whispersystems.textsecuregcm.filters.TimestampResponseFilter;
|
||||
import org.whispersystems.textsecuregcm.grpc.AccountsAnonymousGrpcService;
|
||||
import org.whispersystems.textsecuregcm.grpc.AccountsGrpcService;
|
||||
import org.whispersystems.textsecuregcm.grpc.CallQualitySurveyGrpcService;
|
||||
import org.whispersystems.textsecuregcm.grpc.GrpcAllowListInterceptor;
|
||||
import org.whispersystems.textsecuregcm.grpc.ErrorMappingInterceptor;
|
||||
import org.whispersystems.textsecuregcm.grpc.ExternalServiceCredentialsAnonymousGrpcService;
|
||||
import org.whispersystems.textsecuregcm.grpc.ExternalServiceCredentialsGrpcService;
|
||||
@@ -209,7 +210,6 @@ import org.whispersystems.textsecuregcm.s3.S3MonitoringSupplier;
|
||||
import org.whispersystems.textsecuregcm.securestorage.SecureStorageClient;
|
||||
import org.whispersystems.textsecuregcm.securevaluerecovery.SecureValueRecoveryClient;
|
||||
import org.whispersystems.textsecuregcm.spam.ChallengeConstraintChecker;
|
||||
import org.whispersystems.textsecuregcm.spam.MessageDeliveryListener;
|
||||
import org.whispersystems.textsecuregcm.spam.RegistrationFraudChecker;
|
||||
import org.whispersystems.textsecuregcm.spam.RegistrationRecoveryChecker;
|
||||
import org.whispersystems.textsecuregcm.spam.SpamChecker;
|
||||
@@ -877,6 +877,8 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
|
||||
final MetricServerInterceptor metricServerInterceptor = new MetricServerInterceptor(Metrics.globalRegistry, clientReleaseManager);
|
||||
|
||||
final ErrorMappingInterceptor errorMappingInterceptor = new ErrorMappingInterceptor();
|
||||
final GrpcAllowListInterceptor grpcAllowListInterceptor =
|
||||
new GrpcAllowListInterceptor(config.getGrpcAllowList().enableAll(), config.getGrpcAllowList().enabledServices(), config.getGrpcAllowList().enabledMethods());
|
||||
final RequestAttributesInterceptor requestAttributesInterceptor = new RequestAttributesInterceptor();
|
||||
|
||||
final ValidatingInterceptor validatingInterceptor = new ValidatingInterceptor();
|
||||
@@ -897,6 +899,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
|
||||
// Note: interceptors run in the reverse order they are added; the remote deprecation filter
|
||||
// depends on the user-agent context so it has to come first here!
|
||||
validatingInterceptor,
|
||||
grpcAllowListInterceptor,
|
||||
metricServerInterceptor,
|
||||
errorMappingInterceptor,
|
||||
remoteDeprecationFilter,
|
||||
@@ -916,6 +919,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
|
||||
// depends on the user-agent context so it has to come first here!
|
||||
grpcExternalRequestFilter,
|
||||
validatingInterceptor,
|
||||
grpcAllowListInterceptor,
|
||||
metricServerInterceptor,
|
||||
errorMappingInterceptor,
|
||||
remoteDeprecationFilter,
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
* Copyright 2026 Signal Messenger, LLC
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
package org.whispersystems.textsecuregcm.configuration;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
/// Configure which gRPC methods are enabled
|
||||
///
|
||||
/// @param enableAll enable all gRPC methods
|
||||
/// @param enabledServices A list of fully qualified service names for which all RPCs should be enabled. For example,
|
||||
/// `org.signal.chat.account.AccountsAnonymous` would enable all RPCs on that service, regardless
|
||||
/// of whether the RPCs on that service appear in `enabledMethods`
|
||||
/// @param enabledMethods A list of fully qualified method names of RPCs that should be enabled. For example,
|
||||
/// `org.signal.chat.account.AccountsAnonymous/LookupUsernameHash` would enable the
|
||||
/// `LookupUsernameHash` RPC method
|
||||
public record GrpcAllowListConfiguration(
|
||||
boolean enableAll,
|
||||
List<String> enabledServices,
|
||||
List<String> enabledMethods) {
|
||||
|
||||
public GrpcAllowListConfiguration {
|
||||
if (enabledServices == null) {
|
||||
enabledServices = Collections.emptyList();
|
||||
}
|
||||
if (enabledMethods == null) {
|
||||
enabledMethods = Collections.emptyList();
|
||||
}
|
||||
}
|
||||
|
||||
public GrpcAllowListConfiguration() {
|
||||
// By default, no GRPC methods are accessible
|
||||
this(false, Collections.emptyList(), Collections.emptyList());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
/*
|
||||
* Copyright 2026 Signal Messenger, LLC
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
package org.whispersystems.textsecuregcm.grpc;
|
||||
|
||||
import io.grpc.Metadata;
|
||||
import io.grpc.MethodDescriptor;
|
||||
import io.grpc.ServerCall;
|
||||
import io.grpc.ServerCallHandler;
|
||||
import io.grpc.ServerInterceptor;
|
||||
import io.grpc.Status;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
public class GrpcAllowListInterceptor implements ServerInterceptor {
|
||||
|
||||
private final boolean enableAll;
|
||||
private final Set<String> enabledServices;
|
||||
private final Set<String> enabledMethods;
|
||||
|
||||
|
||||
public GrpcAllowListInterceptor(
|
||||
final boolean enableAll,
|
||||
final List<String> enabledServices,
|
||||
final List<String> enabledMethods) {
|
||||
this.enableAll = enableAll;
|
||||
this.enabledServices = new HashSet<>(enabledServices);
|
||||
this.enabledMethods = new HashSet<>(enabledMethods);
|
||||
}
|
||||
|
||||
@Override
|
||||
public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(final ServerCall<ReqT, RespT> serverCall,
|
||||
final Metadata metadata, final ServerCallHandler<ReqT, RespT> next) {
|
||||
final MethodDescriptor<ReqT, RespT> methodDescriptor = serverCall.getMethodDescriptor();
|
||||
if (!enableAll && !enabledServices.contains(methodDescriptor.getServiceName()) && !enabledMethods.contains(methodDescriptor.getFullMethodName())) {
|
||||
return ServerInterceptorUtil.closeWithStatus(serverCall, Status.UNIMPLEMENTED);
|
||||
}
|
||||
return next.startCall(serverCall, metadata);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Copyright 2026 Signal Messenger, LLC
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
package org.whispersystems.textsecuregcm.grpc;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
import com.google.protobuf.ByteString;
|
||||
import io.grpc.ManagedChannel;
|
||||
import io.grpc.Server;
|
||||
import io.grpc.Status;
|
||||
import io.grpc.inprocess.InProcessChannelBuilder;
|
||||
import io.grpc.inprocess.InProcessServerBuilder;
|
||||
import java.io.IOException;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.signal.chat.rpc.EchoRequest;
|
||||
import org.signal.chat.rpc.EchoResponse;
|
||||
import org.signal.chat.rpc.EchoServiceGrpc;
|
||||
|
||||
class GrpcAllowListInterceptorTest {
|
||||
private Server server;
|
||||
private ManagedChannel channel;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
channel = InProcessChannelBuilder.forName("GrpcAllowListInterceptorTest")
|
||||
.directExecutor()
|
||||
.build();
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() throws Exception {
|
||||
server.shutdownNow();
|
||||
channel.shutdownNow();
|
||||
server.awaitTermination(1, TimeUnit.SECONDS);
|
||||
channel.awaitTermination(1, TimeUnit.SECONDS);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void disableAll() throws Exception {
|
||||
final EchoServiceGrpc.EchoServiceBlockingStub client =
|
||||
setup(false, Collections.emptyList(), Collections.emptyList());
|
||||
GrpcTestUtils.assertStatusException(Status.UNIMPLEMENTED, () ->
|
||||
client.echo(EchoRequest.newBuilder().setPayload(ByteString.empty()).build()));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void enableAll() throws Exception {
|
||||
final EchoServiceGrpc.EchoServiceBlockingStub client =
|
||||
setup(true, Collections.emptyList(), Collections.emptyList());
|
||||
final EchoResponse echo = client.echo(EchoRequest.newBuilder().setPayload(ByteString.empty()).build());
|
||||
assertThat(echo.getPayload()).isEqualTo(ByteString.empty());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void enableByMethod() throws Exception {
|
||||
final EchoServiceGrpc.EchoServiceBlockingStub client =
|
||||
setup(false, Collections.emptyList(), List.of("org.signal.chat.rpc.EchoService/echo"));
|
||||
|
||||
final EchoResponse echo = client.echo(EchoRequest.newBuilder().setPayload(ByteString.empty()).build());
|
||||
assertThat(echo.getPayload()).isEqualTo(ByteString.empty());
|
||||
|
||||
GrpcTestUtils.assertStatusException(Status.UNIMPLEMENTED, () ->
|
||||
client.echo2(EchoRequest.newBuilder().setPayload(ByteString.empty()).build()));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void enableByService() throws Exception {
|
||||
final EchoServiceGrpc.EchoServiceBlockingStub client =
|
||||
setup(false, List.of("org.signal.chat.rpc.EchoService"), Collections.emptyList());
|
||||
|
||||
final EchoResponse echo = client.echo(EchoRequest.newBuilder().setPayload(ByteString.empty()).build());
|
||||
assertThat(echo.getPayload()).isEqualTo(ByteString.empty());
|
||||
|
||||
final EchoResponse echo2 = client.echo2(EchoRequest.newBuilder().setPayload(ByteString.empty()).build());
|
||||
assertThat(echo2.getPayload()).isEqualTo(ByteString.empty());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void enableByServiceWrongService() throws Exception {
|
||||
final EchoServiceGrpc.EchoServiceBlockingStub client =
|
||||
setup(false, List.of("org.signal.chat.rpc.NotEchoService"), Collections.emptyList());
|
||||
|
||||
GrpcTestUtils.assertStatusException(Status.UNIMPLEMENTED, () ->
|
||||
client.echo(EchoRequest.newBuilder().setPayload(ByteString.empty()).build()));
|
||||
}
|
||||
|
||||
private EchoServiceGrpc.EchoServiceBlockingStub setup(
|
||||
boolean enableAll,
|
||||
List<String> enabledServices,
|
||||
List<String> enabledMethods)
|
||||
throws IOException {
|
||||
if (server != null) {
|
||||
server.shutdownNow();
|
||||
}
|
||||
server = InProcessServerBuilder.forName("GrpcAllowListInterceptorTest")
|
||||
.directExecutor()
|
||||
.addService(new EchoServiceImpl())
|
||||
.intercept(new GrpcAllowListInterceptor(enableAll, enabledServices, enabledMethods))
|
||||
.build()
|
||||
.start();
|
||||
|
||||
return EchoServiceGrpc.newBlockingStub(channel);
|
||||
}
|
||||
}
|
||||
@@ -517,6 +517,9 @@ idlePrimaryDeviceReminder:
|
||||
grpc:
|
||||
port: 50051
|
||||
|
||||
grpcAllowList:
|
||||
enableAll: true
|
||||
|
||||
asnTable:
|
||||
s3Region: a-region
|
||||
s3Bucket: a-bucket
|
||||
|
||||
Reference in New Issue
Block a user