Support configurable verification code sender overrides

service/src/main/java/org/whispersystems/textsecuregcm/spam/ScoreThreshold.java

@@ -12,10 +12,11 @@ import java.util.Optional;
 
 /**
  * A ScoreThreshold may be provided by an upstream request filter. If request contains a property for
- * SCORE_THRESHOLD_PROPERTY_NAME it can be forwarded to a downstream filter to indicate it can use
- * a more or less strict score threshold when evaluating whether a request should be allowed to continue.
+ * {@link #PROPERTY_NAME} it can be forwarded to a downstream filter to indicate it can use a more or less strict
+ * score threshold when evaluating whether a request should be allowed to continue.
  */
 public class ScoreThreshold {
+
   private static final Logger logger = LoggerFactory.getLogger(ScoreThreshold.class);
 
   public static final String PROPERTY_NAME = "scoreThreshold";

service/src/main/java/org/whispersystems/textsecuregcm/spam/ScoreThresholdProvider.java

@@ -1,3 +1,7 @@
+/*
+ * Copyright 2023 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
 package org.whispersystems.textsecuregcm.spam;
 
 import java.util.function.Function;
@@ -11,11 +15,11 @@ import org.glassfish.jersey.server.spi.internal.ValueParamProvider;
 
 /**
  * Parses a {@link ScoreThreshold} out of a {@link ContainerRequest} to provide to jersey resources.
- *
+ * <p>
  * A request filter may enrich a ContainerRequest with a scoreThreshold by providing a float property with the name
  * {@link ScoreThreshold#PROPERTY_NAME}. This indicates the desired scoreThreshold to use when evaluating whether a
  * request should proceed.
- *
+ * <p>
  * A resource can consume a ScoreThreshold with by annotating a ScoreThreshold parameter with {@link Extract}
  */
 public class ScoreThresholdProvider implements ValueParamProvider {
@@ -24,6 +28,7 @@ public class ScoreThresholdProvider implements ValueParamProvider {
    * Configures the ScoreThresholdProvider
    */
   public static class ScoreThresholdFeature implements Feature {
+
     @Override
     public boolean configure(FeatureContext context) {
       context.register(new AbstractBinder() {

service/src/main/java/org/whispersystems/textsecuregcm/spam/SenderOverride.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2024 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.whispersystems.textsecuregcm.spam;
+
+import org.glassfish.jersey.server.ContainerRequest;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.util.Optional;
+
+/**
+ * A SenderOverride may be provided by an upstream request filter. If request contains a property for
+ * {@link #SMS_SENDER_OVERRIDE_PROPERTY_NAME} or {@link #VOICE_SENDER_OVERRIDE_PROPERTY_NAME} it can be
+ * forwarded to a downstream filter to indicate a specific sender should be used when sending verification codes.
+ */
+public class SenderOverride {
+
+  private static final Logger logger = LoggerFactory.getLogger(SenderOverride.class);
+  public static final String SMS_SENDER_OVERRIDE_PROPERTY_NAME = "smsSenderOverride";
+  public static final String VOICE_SENDER_OVERRIDE_PROPERTY_NAME = "voiceSenderOverride";
+
+  /**
+   * The name of the sender to use to deliver a verification code via SMS
+   */
+  private final Optional<String> smsSenderOverride;
+
+  /**
+   * The name of the sender to use to deliver a verification code via voice
+   */
+  private final Optional<String> voiceSenderOverride;
+
+  public SenderOverride(final ContainerRequest containerRequest) {
+    this.smsSenderOverride = parse(String.class, SMS_SENDER_OVERRIDE_PROPERTY_NAME, containerRequest);
+    this.voiceSenderOverride = parse(String.class, VOICE_SENDER_OVERRIDE_PROPERTY_NAME, containerRequest);
+  }
+
+  private static <T> Optional<T> parse(Class<T> type, final String propertyName,
+      final ContainerRequest containerRequest) {
+    return Optional
+        .ofNullable(containerRequest.getProperty(propertyName))
+        .flatMap(obj -> {
+          if (type.isInstance(obj)) {
+            return Optional.of(type.cast(obj));
+          }
+          logger.warn("invalid format for filter provided property {}: {}", propertyName, obj);
+          return Optional.empty();
+        });
+  }
+
+
+  public Optional<String> getSmsSenderOverride() {
+    return smsSenderOverride;
+  }
+
+  public Optional<String> getVoiceSenderOverride() {
+    return voiceSenderOverride;
+  }
+
+}

service/src/main/java/org/whispersystems/textsecuregcm/spam/SenderOverrideProvider.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2024 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.whispersystems.textsecuregcm.spam;
+
+import java.util.function.Function;
+import javax.inject.Singleton;
+import javax.ws.rs.core.Feature;
+import javax.ws.rs.core.FeatureContext;
+import org.glassfish.jersey.internal.inject.AbstractBinder;
+import org.glassfish.jersey.server.ContainerRequest;
+import org.glassfish.jersey.server.model.Parameter;
+import org.glassfish.jersey.server.spi.internal.ValueParamProvider;
+
+/**
+ * Parses a {@link SenderOverride} out of a {@link ContainerRequest} to provide to jersey resources.
+ * <p>
+ * A request filter may enrich a ContainerRequest with senderOverrides by providing a string property names defined in
+ * {@link SenderOverride}. This indicates the desired senderOverride to use when sending verification codes.
+ * <p>
+ * A resource can consume a SenderOverride with by annotating a SenderOverride parameter with {@link Extract}
+ */
+public class SenderOverrideProvider implements ValueParamProvider {
+
+  /**
+   * Configures the SenderOverrideProvider
+   */
+  public static class SenderOverrideFeature implements Feature {
+
+    @Override
+    public boolean configure(FeatureContext context) {
+      context.register(new AbstractBinder() {
+        @Override
+        protected void configure() {
+          bind(SenderOverrideProvider.class)
+              .to(ValueParamProvider.class)
+              .in(Singleton.class);
+        }
+      });
+      return true;
+    }
+  }
+
+  @Override
+  public Function<ContainerRequest, ?> getValueProvider(final Parameter parameter) {
+    if (parameter.getRawType().equals(SenderOverride.class)
+        && parameter.isAnnotationPresent(Extract.class)) {
+      return SenderOverride::new;
+    }
+    return null;
+
+  }
+
+  @Override
+  public PriorityType getPriority() {
+    return Priority.HIGH;
+  }
+}