ANCHOR-403 Refactor TOML Exception obfuscation for URL/Parsing to Toml Functions our of NetUtil

build.gradle.kts

@@ -135,7 +135,7 @@ subprojects {
 
 allprojects {
   group = "org.stellar.anchor-sdk"
-  version = "2.1.2"
+  version = "2.1.3"
 
   tasks.jar {
     manifest {

core/src/main/java/org/stellar/anchor/sep1/Sep1Service.java

@@ -1,6 +1,5 @@
 package org.stellar.anchor.sep1;
 
-import static org.stellar.anchor.util.Log.debug;
 import static org.stellar.anchor.util.Log.debugF;
 import static org.stellar.anchor.util.MetricConstants.SEP1_TOML_ACCESSED;
 
@@ -27,10 +26,10 @@ public class Sep1Service {
    */
   public Sep1Service(Sep1Config sep1Config) throws IOException, InvalidConfigException {
     if (sep1Config.isEnabled()) {
-      debug("sep1Config:", sep1Config);
+      debugF("sep1Config: {}", sep1Config);
       switch (sep1Config.getType()) {
         case STRING:
-          debug("reading stellar.toml from config[sep1.toml.value]");
+          debugF("reading stellar.toml from config[sep1.toml.value]");
           tomlValue = sep1Config.getValue();
           break;
         case FILE:
@@ -39,7 +38,7 @@ public Sep1Service(Sep1Config sep1Config) throws IOException, InvalidConfigExcep
           break;
         case URL:
           debugF("reading stellar.toml from {}", sep1Config.getValue());
-          tomlValue = NetUtil.fetch(sep1Config.getValue());
+          tomlValue = fetchTomlFromURL(sep1Config.getValue());
           break;
         default:
           throw new InvalidConfigException(
@@ -50,6 +49,17 @@ public Sep1Service(Sep1Config sep1Config) throws IOException, InvalidConfigExcep
     }
   }
 
+  private String fetchTomlFromURL(String url) throws IOException {
+    try {
+      return NetUtil.fetch(url);
+    } catch (IOException e) {
+      // Obfuscate the message and rethrow
+      String obfuscatedMessage = String.format("Unable to fetch data from %s", url);
+      debugF(e.toString()); // Log the obfuscated message using the debugF method
+      throw new IOException(obfuscatedMessage); // Preserve the original exception as the cause
+    }
+  }
+
   public String getStellarToml() {
     sep1TomlAccessedCounter.increment();
     return tomlValue;

core/src/main/java/org/stellar/anchor/util/NetUtil.java

@@ -1,5 +1,6 @@
 package org.stellar.anchor.util;
 
+import static org.stellar.anchor.util.Log.debugF;
 import static org.stellar.anchor.util.StringHelper.isEmpty;
 
 import io.jsonwebtoken.lang.Strings;
@@ -13,12 +14,30 @@
 import okhttp3.Response;
 
 public class NetUtil {
+
   public static String fetch(String url) throws IOException {
-    Request request = OkHttpUtil.buildGetRequest(url);
-    Response response = getCall(request).execute();
 
-    if (response.body() == null) return "";
-    return Objects.requireNonNull(response.body()).string();
+    try {
+      Request request = OkHttpUtil.buildGetRequest(url);
+      Response response = getCall(request).execute();
+      String message =
+          String.format("NetUtil:fetch of %s unsuccessful. response: %s", url, response.toString());
+
+      // Check if response was unsuccessful (ie not status code 2xx) and throw IOException
+      if (!response.isSuccessful()) {
+        debugF(message);
+        throw new IOException(message);
+      }
+
+      if (response.body() == null) {
+        debugF(message);
+        throw new IOException(message);
+      }
+      return Objects.requireNonNull(response.body()).string();
+    } catch (IOException e) {
+      debugF(e.toString());
+      throw e;
+    }
   }
 
   @SuppressWarnings("BooleanMethodIsAlwaysInverted")

core/src/main/java/org/stellar/anchor/util/Sep1Helper.java

@@ -1,24 +1,43 @@
 package org.stellar.anchor.util;
 
+import static org.stellar.anchor.util.Log.*;
+
 import com.moandjiezana.toml.Toml;
 import java.io.IOException;
 import java.net.URL;
+import org.stellar.anchor.api.exception.InvalidConfigException;
 
 public class Sep1Helper {
   public static TomlContent readToml(String url) throws IOException {
     return new TomlContent(new URL(url));
   }
 
-  public static TomlContent parse(String tomlString) {
-    return new TomlContent(tomlString);
+  public static TomlContent parse(String tomlString) throws InvalidConfigException {
+    try {
+      return new TomlContent(tomlString);
+    } catch (Exception e) {
+      // Obfuscate the message and rethrow
+      String obfuscatedMessage = "Failed to parse TOML content. Invalid Config.";
+      debugF(e.toString()); // Log the exception
+      throw new InvalidConfigException(
+          obfuscatedMessage); // Preserve the original exception as the cause
+    }
   }
 
   public static class TomlContent {
     private final Toml toml;
 
     TomlContent(URL url) throws IOException {
-      String tomlValue = NetUtil.fetch(url.toString());
-      toml = new Toml().read(tomlValue);
+      try {
+        String tomlValue = NetUtil.fetch(url.toString());
+        toml = new Toml().read(tomlValue);
+      } catch (IOException e) {
+        // Obfuscate the message and rethrow
+        String obfuscatedMessage =
+            String.format("An error occurred while fetching the TOML from %s", url);
+        Log.error(e.toString());
+        throw new IOException(obfuscatedMessage); // Preserve the original exception as the cause
+      }
     }
 
     TomlContent(String tomlString) {

core/src/test/kotlin/org/stellar/anchor/util/NetUtilTest.kt

@@ -4,11 +4,13 @@ package org.stellar.anchor.util
 
 import io.mockk.*
 import io.mockk.impl.annotations.MockK
+import java.io.IOException
 import java.net.MalformedURLException
 import okhttp3.Response
 import okhttp3.ResponseBody
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Assertions.assertThrows
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.params.ParameterizedTest
@@ -36,31 +38,42 @@ internal class NetUtilTest {
   }
 
   @Test
-  fun `test fetch()`() {
+  fun `test fetch successful response`() {
     mockkStatic(NetUtil::class)
     every { NetUtil.getCall(any()) } returns mockCall
     every { mockCall.execute() } returns mockResponse
+    every { mockResponse.isSuccessful } returns true
     every { mockResponse.body } returns mockResponseBody
     every { mockResponseBody.string() } returns "result"
 
     val result = NetUtil.fetch("http://hello")
-    assert(result.equals("result"))
+    assertEquals("result", result)
+
     verify {
       NetUtil.getCall(any())
       mockCall.execute()
     }
   }
 
   @Test
-  fun `test fetch() throws exception`() {
+  fun `test fetch unsuccessful response`() {
+    mockkStatic(NetUtil::class)
+    every { NetUtil.getCall(any()) } returns mockCall
+    every { mockCall.execute() } returns mockResponse
+    every { mockResponse.isSuccessful } returns false
+
+    assertThrows(IOException::class.java) { NetUtil.fetch("http://hello") }
+  }
+
+  @Test
+  fun `test fetch null response body`() {
     mockkStatic(NetUtil::class)
     every { NetUtil.getCall(any()) } returns mockCall
     every { mockCall.execute() } returns mockResponse
+    every { mockResponse.isSuccessful } returns true
     every { mockResponse.body } returns null
-    every { mockResponseBody.string() } returns "result"
 
-    val result = NetUtil.fetch("http://hello")
-    assert(result.equals(""))
+    assertThrows(IOException::class.java) { NetUtil.fetch("http://hello") }
   }
 
   @Test

core/src/test/kotlin/org/stellar/anchor/util/Sep1HelperTest.kt

@@ -0,0 +1,75 @@
+package org.stellar.anchor.util
+
+import java.io.IOException
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.stellar.anchor.api.exception.InvalidConfigException
+
+class Sep1HelperTest {
+  val stellarToml =
+    """
+          ACCOUNTS = [ "GCSGSR6KQQ5BP2FXVPWRL6SWPUSFWLVONLIBJZUKTVQB5FYJFVL6XOXE" ]
+          VERSION = "0.1.0"
+          SIGNING_KEY = "GBDYDBJKQBJK4GY4V7FAONSFF2IBJSKNTBYJ65F5KCGBY2BIGPGGLJOH"
+          NETWORK_PASSPHRASE = "Test SDF Network ; September 2015"
+
+          WEB_AUTH_ENDPOINT = "http://localhost:8080/auth"
+          KYC_SERVER = "http://localhost:8080/sep12"
+          TRANSFER_SERVER_SEP0024 = "http://localhost:8080/sep24"
+          DIRECT_PAYMENT_SERVER = "http://localhost:8080/sep31"
+          ANCHOR_QUOTE_SERVER = "http://localhost:8080/sep38"
+
+          [[CURRENCIES]]
+          code = "SRT"
+          issuer = "GCDNJUBQSX7AJWLJACMJ7I4BC3Z47BQUTMHEICZLE6MU4KQBRYG5JY6B"
+          status = "test"
+          is_asset_anchored = false
+          anchor_asset_type = "other"
+          desc = "A fake anchored asset to use with this example anchor server."
+
+          [DOCUMENTATION]
+          ORG_NAME = "Stellar Development Foundation"
+          ORG_URL = "https://stellar.org"
+          ORG_DESCRIPTION = "SEP 24 reference server."
+          ORG_KEYBASE = "stellar.public"
+          ORG_TWITTER = "StellarOrg"
+          ORG_GITHUB = "stellar"
+        """
+      .trimIndent()
+
+  private val mockWebServer = MockWebServer()
+
+  @BeforeEach
+  fun setup() {
+    mockWebServer.start()
+  }
+
+  @AfterEach
+  fun teardown() {
+    mockWebServer.shutdown()
+  }
+
+  @Test
+  fun `test Read Toml with IOException`() {
+    // Enqueue a response with an HTTP error status code
+    mockWebServer.enqueue(MockResponse().setResponseCode(500))
+    val exception =
+      assertThrows(IOException::class.java) {
+        Sep1Helper.readToml(mockWebServer.url("/").toString())
+      }
+    // You may need to adjust the assertion based on the specific behavior of Sep1Helper
+    assertTrue(exception.message!!.contains("An error occurred while fetching the TOML from"))
+  }
+
+  @Test
+  fun `test Parse Invalid Toml String`() {
+    val invalidTomlString = "key = value" // An invalid TOML string without quotes
+    val exception =
+      assertThrows(InvalidConfigException::class.java) { Sep1Helper.parse(invalidTomlString) }
+    assertEquals("Failed to parse TOML content. Invalid Config.", exception.message)
+  }
+}

platform/src/main/java/org/stellar/anchor/platform/config/PropertySep1Config.java

@@ -6,6 +6,7 @@
 import org.springframework.validation.Errors;
 import org.springframework.validation.ValidationUtils;
 import org.springframework.validation.Validator;
+import org.stellar.anchor.api.exception.InvalidConfigException;
 import org.stellar.anchor.config.Sep1Config;
 import org.stellar.anchor.util.NetUtil;
 import org.stellar.anchor.util.Sep1Helper;
@@ -59,12 +60,11 @@ void validateTomlTypeAndValue(PropertySep1Config config, Errors errors) {
         case STRING:
           try {
             Sep1Helper.parse(config.getToml().getValue());
-          } catch (IllegalStateException isex) {
+          } catch (InvalidConfigException e) {
             errors.rejectValue(
                 "value",
                 "sep1-toml-value-string-invalid",
-                String.format(
-                    "sep1.toml.value does not contain a valid TOML. %s", isex.getMessage()));
+                String.format("sep1.toml.value does not contain a valid TOML. %s", e.getMessage()));
           }
           break;
         case URL:

platform/src/main/java/org/stellar/anchor/platform/controller/sep/Sep1Controller.java

@@ -1,5 +1,6 @@
 package org.stellar.anchor.platform.controller.sep;
 
+import java.io.IOException;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -40,7 +41,7 @@ public RedirectView landingPage() throws SepNotFoundException {
   @RequestMapping(
       value = "/.well-known/stellar.toml",
       method = {RequestMethod.GET, RequestMethod.OPTIONS})
-  public ResponseEntity<String> getToml() throws SepNotFoundException {
+  public ResponseEntity<String> getToml() throws IOException, SepNotFoundException {
     if (!sep1Config.isEnabled()) {
       throw new SepNotFoundException("Not Found");
     }