cf: analyze API key when auth failures (#611)

Author: itzg

src/main/java/me/itzg/helpers/curseforge/ApiKeyHelper.java

@@ -0,0 +1,35 @@
+package me.itzg.helpers.curseforge;
+
+import org.slf4j.Logger;
+
+public class ApiKeyHelper {
+
+    public static final String EXPECTED_API_KEY_PREFIX = "$2a$10$";
+
+    static String partiallyRedactApiKey(String apiKey) {
+        final int trailingAmount = 2;
+        // too short?
+        if (apiKey.length() <= trailingAmount + EXPECTED_API_KEY_PREFIX.length()) {
+            // show half of it
+            return apiKey.substring(0, apiKey.length() / 2);
+        }
+
+        return apiKey.substring(0, EXPECTED_API_KEY_PREFIX.length()) +
+            "*****" + apiKey.substring(apiKey.length() - trailingAmount);
+    }
+
+    public static void logKeyIssues(Logger log, String apiKey) {
+        if (apiKey.startsWith("$$")) {
+            log.error("The API key seems to have extra dollar sign escaping since "
+                    + "it looked like '{}' but should start with '{}'.",
+                partiallyRedactApiKey(apiKey), EXPECTED_API_KEY_PREFIX
+            );
+        }
+        else if (!apiKey.startsWith(EXPECTED_API_KEY_PREFIX)) {
+            log.error("The API key should start with '{}' but yours looked like '{}'."
+                    + " Make sure to escape dollar signs with two each.",
+                EXPECTED_API_KEY_PREFIX, partiallyRedactApiKey(apiKey)
+            );
+        }
+    }
+}

src/main/java/me/itzg/helpers/curseforge/CurseForgeApiClient.java

@@ -24,6 +24,7 @@
 import me.itzg.helpers.curseforge.model.GetModResponse;
 import me.itzg.helpers.curseforge.model.ModsSearchResponse;
 import me.itzg.helpers.errors.GenericException;
+import me.itzg.helpers.errors.InvalidApiKeyException;
 import me.itzg.helpers.errors.InvalidParameterException;
 import me.itzg.helpers.errors.RateLimitException;
 import me.itzg.helpers.http.FailedRequestException;
@@ -174,7 +175,12 @@ public CurseForgeFile resolveModpackFile(
                 )
             )
             .toObject(GetModFilesResponse.class)
-            .execute();
+            .assemble()
+            .onErrorMap(FailedRequestException::isForbidden, this::errorMapForbidden)
+            .block();
+        if (resp == null) {
+            throw new GenericException("Unable to resolve modpack's file");
+        }
 
         final List<CurseForgeFile> files = resp.getData();
 
@@ -313,7 +319,7 @@ public Throwable errorMapForbidden(Throwable throwable) {
             return new RateLimitException(null, String.format("Access to %s has been rate-limited.", uriBuilder.getBaseUrl()), e);
         }
         else {
-            return new InvalidParameterException(String.format("Access to %s is forbidden or rate-limit has been exceeded."
+            return new InvalidApiKeyException(String.format("Access to %s is forbidden or rate-limit has been exceeded."
                     + " Ensure %s is set to a valid API key from %s or allow rate-limit to reset.",
                 uriBuilder.getBaseUrl(), API_KEY_VAR, ETERNAL_DEVELOPER_CONSOLE_URL
             ), e

src/main/java/me/itzg/helpers/curseforge/CurseForgeFilesCommand.java

@@ -24,6 +24,7 @@
 import me.itzg.helpers.curseforge.model.FileDependency;
 import me.itzg.helpers.curseforge.model.FileRelationType;
 import me.itzg.helpers.curseforge.model.ModLoaderType;
+import me.itzg.helpers.errors.InvalidApiKeyException;
 import me.itzg.helpers.errors.InvalidParameterException;
 import me.itzg.helpers.files.Manifests;
 import me.itzg.helpers.http.SharedFetchArgs;
@@ -128,11 +129,14 @@ public Integer call() throws Exception {
                 newManifest =
                     apiClient.loadCategoryInfo(Arrays.asList(CATEGORY_MC_MODS, CATEGORY_BUKKIT_PLUGINS))
                     .flatMap(categoryInfo ->
+
                         processModFileRefs(categoryInfo, previousFiles, apiClient)
                             .map(entries -> CurseForgeFilesManifest.builder()
                                 .entries(entries)
                                 .build()))
-                    .block();
+                        .doOnError(InvalidApiKeyException.class,
+                            throwable -> ApiKeyHelper.logKeyIssues(log, apiKey))
+                        .block();
             }
         }
         else {

src/main/java/me/itzg/helpers/curseforge/CurseForgeInstaller.java

@@ -46,6 +46,7 @@
 import me.itzg.helpers.curseforge.model.MinecraftModpackManifest;
 import me.itzg.helpers.curseforge.model.ModLoader;
 import me.itzg.helpers.errors.GenericException;
+import me.itzg.helpers.errors.InvalidApiKeyException;
 import me.itzg.helpers.errors.InvalidParameterException;
 import me.itzg.helpers.fabric.FabricLauncherInstaller;
 import me.itzg.helpers.files.Manifests;
@@ -239,6 +240,9 @@ void install(String slug, InstallationEntryPoint entryPoint) {
 
         } catch (IOException e) {
             throw new GenericException("File system issue during installation", e);
+        } catch (InvalidApiKeyException e) {
+            ApiKeyHelper.logKeyIssues(log, apiKey);
+            throw e;
         }
     }
 

src/main/java/me/itzg/helpers/errors/InvalidApiKeyException.java

@@ -0,0 +1,15 @@
+package me.itzg.helpers.errors;
+
+import picocli.CommandLine.ExitCode;
+
+@EmitsExitCode(ExitCode.USAGE)
+public class InvalidApiKeyException extends InvalidParameterException {
+
+    public InvalidApiKeyException(String message) {
+        super(message);
+    }
+
+    public InvalidApiKeyException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}