feat: remove the api key from the vscode extension settings

Author: gg-jonathangriffe

package.json

@@ -41,11 +41,6 @@
           "default": "https://dashboard.gitguardian.com",
           "markdownDescription": "You can override the value here for On Premise installations"
         },
-        "gitguardian.apiKey": {
-          "type": "string",
-          "default": "",
-          "markdownDescription": "Your API Key"
-        },
         "gitguardian.allowSelfSigned": {
           "type": "boolean",
           "default": false,

src/extension.ts

@@ -10,10 +10,7 @@ import {
   scanFile,
   showAPIQuota,
 } from "./lib/ggshield-api";
-import {
-  getConfiguration,
-  setApiKey,
-} from "./lib/ggshield-configuration-utils";
+import { getConfiguration } from "./lib/ggshield-configuration-utils";
 import {
   ExtensionContext,
   Uri,
@@ -138,7 +135,6 @@ export function activate(context: ExtensionContext) {
       ggshieldAuthStatus(configuration, context);
       if (context.globalState.get("isAuthenticated", false)) {
         updateStatusBarItem(StatusBarStatus.ready);
-        setApiKey(configuration, ggshieldApiKey(configuration));
         ggshieldViewProvider.refresh();
         ggshieldRemediationMessageViewProvider.refresh();
         ggshieldQuotaViewProvider.refresh();
@@ -219,7 +215,6 @@ export function activate(context: ExtensionContext) {
             .then(() => {
               if (context.globalState.get("isAuthenticated", false)) {
                 updateStatusBarItem(StatusBarStatus.ready);
-                setApiKey(configuration, ggshieldApiKey(configuration));
               } else {
                 updateStatusBarItem(StatusBarStatus.unauthenticated);
               }
@@ -234,7 +229,6 @@ export function activate(context: ExtensionContext) {
         commands.registerCommand("gitguardian.logout", async () => {
           logoutGGShield(ggshieldResolver.configuration, context);
           updateStatusBarItem(StatusBarStatus.unauthenticated);
-          setApiKey(configuration, undefined);
           ggshieldViewProvider.refresh();
           ggshieldRemediationMessageViewProvider.refresh();
           ggshieldQuotaViewProvider.refresh();

src/ggshield-webview/gitguardian-remediation-message-view.ts

@@ -1,4 +1,3 @@
-import { getRemediationMessage } from "../lib/ggshield-api";
 import { GGShieldConfiguration } from "../lib/ggshield-configuration";
 import * as vscode from "vscode";
 
@@ -46,9 +45,8 @@ export class GitGuardianRemediationMessageWebviewProvider
 
   private async updateRemediationMessage() {
     if (this.isAuthenticated) {
-      this.remediationMessage = await getRemediationMessage(
-        this.ggshieldConfiguration
-      );
+      //TODO: Get remediation message
+      this.remediationMessage = "";
     }
   }
 

src/lib/ggshield-api.ts

@@ -59,23 +59,6 @@ export async function getAPIquota(
   }
 }
 
-export async function getRemediationMessage(
-  configuration: GGShieldConfiguration
-): Promise<string> {
-  const apiUrl = dasboardToApi(configuration.apiUrl);
-  const path = require("node:path");
-  try {
-    const response = await axios.get(path.join(apiUrl, "v1/metadata"), {
-      headers: {
-        authorization: `Token ${configuration.apiKey}`,
-      },
-    });
-    return response.data.remediation_messages.pre_commit;
-  } catch (error) {
-    return "An error occurred.";
-  }
-}
-
 /**
  * Ignore last found secrets
  *
@@ -214,7 +197,7 @@ export async function loginGGShield(
   webviewView: WebviewView,
   context: ExtensionContext
 ): Promise<void> {
-  const { ggshieldPath, apiUrl, apiKey } = configuration;
+  const { ggshieldPath, apiUrl } = configuration;
 
   let options: SpawnOptionsWithoutStdio = {
     cwd: os.tmpdir(),

src/lib/ggshield-configuration-utils.ts

@@ -18,21 +18,12 @@ export function getConfiguration(
 
   const ggshieldPath: string | undefined = config.get("GGShieldPath");
   const apiUrl: string | undefined = config.get("apiUrl");
-  const apiKey: string | undefined = config.get("apiKey");
   const allowSelfSigned: boolean = config.get("allowSelfSigned", false);
   return new GGShieldConfiguration(
     ggshieldPath
       ? ggshieldPath
       : getBinaryAbsolutePath(os.platform(), os.arch(), context),
     apiUrl || apiUrlDefault,
-    apiKey || "",
     allowSelfSigned || false
   );
 }
-
-export function setApiKey(
-  configuration: GGShieldConfiguration,
-  apiKey: string | undefined
-): void {
-  configuration.apiKey = apiKey ? apiKey : "";
-}

src/lib/ggshield-configuration.ts

@@ -1,18 +1,15 @@
 export class GGShieldConfiguration {
   ggshieldPath: string;
   apiUrl: string;
-  apiKey: string;
   allowSelfSigned: boolean;
 
   constructor(
     ggshieldPath: string = "",
     apiUrl: string = "",
-    apiKey: string = "",
     allowSelfSigned: boolean = false
   ) {
     this.ggshieldPath = ggshieldPath;
     this.apiUrl = apiUrl;
-    this.apiKey = apiKey;
     this.allowSelfSigned = allowSelfSigned;
   }
 }

src/lib/run-ggshield.ts

@@ -19,17 +19,13 @@ export function runGGShieldCommand(
   configuration: GGShieldConfiguration,
   args: string[]
 ): SpawnSyncReturns<string> {
-  const { ggshieldPath, apiUrl, apiKey } = configuration;
+  const { ggshieldPath, apiUrl } = configuration;
   let env: NodeJS.ProcessEnv = {
     ...process.env,
     GITGUARDIAN_INSTANCE: apiUrl,
     GG_USER_AGENT: "gitguardian-vscode",
   };
 
-  if (apiKey) {
-    env.GITGUARDIAN_API_KEY = apiKey;
-  }
-
   let options: SpawnSyncOptionsWithStringEncoding = {
     cwd: os.tmpdir(),
     env: env,

src/test/suite/lib/ggshield-configuration-utils.test.ts

@@ -24,9 +24,6 @@ suite("getConfiguration", () => {
         if (key === "apiUrl") {
           return "https://custom-url.com";
         }
-        if (key === "apiKey") {
-          return "test-api-key";
-        }
         if (key === "allowSelfSigned") {
           return true;
         }
@@ -43,7 +40,6 @@ suite("getConfiguration", () => {
     // Assert that the configuration has the expected values
     assert.strictEqual(configuration.ggshieldPath, "path/to/ggshield");
     assert.strictEqual(configuration.apiUrl, "https://custom-url.com");
-    assert.strictEqual(configuration.apiKey, "test-api-key");
     assert.strictEqual(configuration.allowSelfSigned, true);
   });
 });

src/test/suite/lib/run-ggshield.test.ts

@@ -21,7 +21,6 @@ suite("runGGShieldCommand", () => {
       {
         ggshieldPath: "path/to/ggshield",
         apiUrl: "",
-        apiKey: "",
       } as GGShieldConfiguration,
       []
     );
@@ -58,7 +57,6 @@ suite("runGGShieldCommand", () => {
         {
           ggshieldPath: "path/to/ggshield",
           apiUrl: "",
-          apiKey: "",
           allowSelfSigned: allowSelfSigned,
         } as GGShieldConfiguration,
         ["test"]