@aikidosec/ci-api-client 1.0.3 → 1.0.5

package/README.md

@@ -31,14 +31,14 @@ $ aikido-api-client apikey <your-api-key-here>
 Using the `aikido-api-client` to start new scans is very straightforward.
 
 ```sh
-$ aikido-api-client scan <repository_id> <base_commit_id> <head_commit_id>
+$ aikido-api-client scan <repository_id or repository_name> <base_commit_id> <head_commit_id>
 ```
 
 The process will report scan progress and will exit with exitCode `0` if the scan was successfull (`gate_passed: true`). The process will exit with exitCode `10` if the scan was unsuccesfull (`gate_passed: false`). If anything else goes wrong (e.g. API unavailable, scanning unavailable, other unexpected issue) the process will exit with exitCode `1`.
 
 If you want the scan to run quietly (without output), you can add the `--quiet` option to the command.
 
-Please note that the repository_id which you need to provide to the CLI is the unique ID of the Git provider you are using, not the ID of the repository in Aikido. You can also find this ID in Aikido, by going to the repository's detail page and clicking on the Git provider's icon in the header.
+Please note that the repository_id which you need to provide to the CLI is the unique ID of the Git provider you are using, not the ID of the repository in Aikido. You can also find this ID in Aikido, by going to the repository's detail page and clicking on the Git provider's icon in the header. Alternatively, you can pass the repository name as it is defined in Aikido.
 
 ```sh
 # For more options and combinations, check the help output

package/lib/aikidoApi.d.ts

@@ -11,6 +11,7 @@ export type TScanApiOptions = {
     fail_on_dependency_scan?: boolean;
     fail_on_sast_scan?: boolean;
     fail_on_iac_scan?: boolean;
+    fail_on_secrets_scan?: boolean;
     minimum_severity?: string;
     version: string;
 };
@@ -23,6 +24,7 @@ export type TPollIsScanningResult = {
     dependency_scan_completed: boolean;
     sast_scan_completed: boolean;
     iac_scan_completed: boolean;
+    secrets_scan_completed: boolean;
     sbom_scan_completed?: boolean;
 };
 type TPollScanCompletedOptions = {
@@ -33,6 +35,7 @@ type TPollScanFeatureBranchCompletedOptions = {
     new_dependency_issues_found: number;
     new_sast_issues_found: number;
     new_iac_issues_found: number;
+    new_leaked_secret_issues_found: number;
     diff_url: string;
 };
 type TPollScanDefaultBranchCompletedOptions = {

package/lib/commands/scan.d.ts

@@ -21,6 +21,7 @@ type TScanUserCliOptions = {
     selfManagedScanners?: string[];
     failOnDependencyScan?: boolean;
     failOnSastScan?: boolean;
+    failOnSecretsScan?: boolean;
     failOnIacScan?: boolean;
     minimumSeverityLevel?: string;
     pollInterval?: number;

package/lib/commands/scan.js

@@ -144,6 +144,9 @@ const parseCliOptions = (userCliOptions) => {
     if (userCliOptions.failOnIacScan != undefined) {
         apiOptions.fail_on_iac_scan = userCliOptions.failOnIacScan;
     }
+    if (userCliOptions.failOnSecretsScan != undefined) {
+        apiOptions.fail_on_secrets_scan = userCliOptions.failOnSecretsScan;
+    }
     if (userCliOptions.minimumSeverityLevel) {
         apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
     }
@@ -182,6 +185,7 @@ export const cliSetup = (program) => program
     .addOption(new Option('--no-fail-on-dependency-scan', "Don't fail when scanning depedencies..."))
     .option('--fail-on-sast-scan', 'Let Aikido fail when new static code analysis issues have been detected...')
     .option('--fail-on-iac-scan', 'Let Aikido fail when new infrastructure as code issues have been detected...')
+    .option('--fail-on-secrets-scan', 'Let Aikido fail when new leaked secrets have been detected...')
     .addOption(new Option('--minimum-severity-level <level>', 'Set the minimum severity level. Accepted options are: LOW, MEDIUM, HIGH and CRITICAL.').choices(['LOW', 'MEDIUM', 'HIGH', 'CRITICAL']))
     .addOption(new Option('--poll-interval [interval]', 'The poll interval when checking for an updated scan result')
     .preset(5)

package/lib/index.js

@@ -10,7 +10,7 @@ export const program = new Command();
 program
     .name('Aikido API Client')
     .description('CLI api client to easily integrate the Aikido public CI API into custom deploy scripts')
-    .version('1.0.3');
+    .version('1.0.4');
 apiKey.cliSetup(program);
 scan.cliSetup(program);
 upload.cliSetup(program);

package/lib/output.js

@@ -17,30 +17,24 @@ export const outputError = (message, exitCode = 1) => {
     });
 };
 export const outputHttpError = (axiosError) => {
-    if (axiosError.code === 'ECONNREFUSED') {
-        outputError(`Could not connect to Aikido API (${axiosError.message}). Please verify your network settings`);
-    }
-    else if (axiosError.response?.status &&
-        axiosError.response?.status === 401) {
-        outputError('Request failed. The provided api key is most likely no longer valid and has been rotated or revoked. Visit https://app.aikido.dev/settings/integrations/continuous-integration to generate a new key.');
-    }
-    else if (axiosError.response?.status &&
-        axiosError.response?.status === 403) {
-        outputError('Could not authenticate with the Aikido API. Please verify your Aikdio API key.');
-    }
-    else if (axiosError.response?.status &&
-        axiosError.response?.status === 500) {
-        outputError('Something went wrong contacting the Aikido API.');
-    }
-    const statusStr = axiosError.response?.status
-        ? ` (${axiosError.response?.status})`
-        : '';
-    if (axiosError.response) {
-        outputDebug(axiosError.response?.status);
-        outputDebug(axiosError.response?.headers);
-        outputDebug(axiosError.response?.data);
-    }
-    outputError(`Something unexpected went wrong${statusStr}... Please contact us if this problem persists.`);
+    outputDebug(axiosError);
+    if (axiosError.isAxiosError) {
+        if (axiosError.response) {
+            const statusStr = `${axiosError.response.status} ${axiosError.response.statusText}`;
+            switch (axiosError.response.status) {
+                case 401:
+                    return outputError(`${statusStr}: The provided api key is most likely no longer valid and has been rotated or revoked. Visit https://app.aikido.dev/settings/integrations/continuous-integration to generate a new key.`);
+                case 403:
+                    return outputError(`${statusStr}: Could not authenticate with the Aikido API. Please verify your Aikdio API key.`);
+                case 500:
+                    return outputError(`${statusStr}: Something went wrong contacting the Aikido API. Please try again later.`);
+                default:
+                    return outputError(`${statusStr}: ${axiosError.response.data ?? ''} Please contact us if this problem persists.`);
+            }
+        }
+        return outputError(`${axiosError.name}: ${axiosError.message}`);
+    }
+    return outputError('Unexpected error occurred. Please contact us if this problem persists.');
 };
 export const startSpinner = (message) => {
     if (process.env.QUIET) {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "CLI api client to easily integrate the Aikido public CI API into custom deploy scripts",
   "license": "MIT",
   "author": "Bert Devriese <bert@builtinbruges.com>",
+  "private": false,
   "type": "module",
   "main": "lib/index.js",
   "bin": {
@@ -18,7 +19,10 @@
     "build": "tsc -p .",
     "local": "yarn build && yarn global add file:$PWD; aikido-api-client",
     "local-rm": "yarn global remove aikido-api-client",
-    "format": "prettier --write 'src/**/*.ts'"
+    "format": "prettier --write 'src/**/*.ts'",
+    "//": {
+      "refresh": "rm -rf ./node_modules ./yarn.lock && yarn"
+    }
   },
   "dependencies": {
     "axios": "^1.4.0",
@@ -43,6 +47,5 @@
     "aikido",
     "security",
     "cli"
-  ],
-  "packageManager": "yarn@4.1.1"
-}
+  ]
+}

package/src/aikidoApi.ts

@@ -22,6 +22,7 @@ export type TScanApiOptions = {
   fail_on_dependency_scan?: boolean;
   fail_on_sast_scan?: boolean;
   fail_on_iac_scan?: boolean;
+  fail_on_secrets_scan?: boolean;
   minimum_severity?: string;
   version: string;
 };
@@ -58,6 +59,7 @@ export type TPollIsScanningResult = {
   dependency_scan_completed: boolean;
   sast_scan_completed: boolean;
   iac_scan_completed: boolean;
+  secrets_scan_completed: boolean;
   sbom_scan_completed?: boolean;
 };
 
@@ -70,6 +72,7 @@ type TPollScanFeatureBranchCompletedOptions = {
   new_dependency_issues_found: number;
   new_sast_issues_found: number;
   new_iac_issues_found: number;
+  new_leaked_secret_issues_found: number;
   diff_url: string;
 };
 

package/src/commands/apiKey.ts

@@ -5,7 +5,8 @@ import { outputError, outputLog } from '../output.js';
 const API_KEY_REGEX = /^AIK_CI_[a-zA-Z0-9]{64}$/g;
 
 function cli(apiKey: string): void {
-  const isValidApiKey = API_KEY_REGEX.test(apiKey) || apiKey.trim().length === 128;
+  const isValidApiKey =
+    API_KEY_REGEX.test(apiKey) || apiKey.trim().length === 128;
   if (apiKey && !isValidApiKey) {
     outputError('That does not seem right, please verify your api key');
   }

package/src/commands/scan.ts

@@ -59,6 +59,7 @@ type TScanUserCliOptions = {
   selfManagedScanners?: string[];
   failOnDependencyScan?: boolean;
   failOnSastScan?: boolean;
+  failOnSecretsScan?: boolean;
   failOnIacScan?: boolean;
   minimumSeverityLevel?: string;
   pollInterval?: number;
@@ -271,6 +272,9 @@ const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   if (userCliOptions.failOnIacScan != undefined) {
     apiOptions.fail_on_iac_scan = userCliOptions.failOnIacScan;
   }
+  if (userCliOptions.failOnSecretsScan != undefined) {
+    apiOptions.fail_on_secrets_scan = userCliOptions.failOnSecretsScan;
+  }
   if (userCliOptions.minimumSeverityLevel) {
     apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
   }
@@ -353,6 +357,10 @@ export const cliSetup = (program: Command) =>
       '--fail-on-iac-scan',
       'Let Aikido fail when new infrastructure as code issues have been detected...'
     )
+    .option(
+      '--fail-on-secrets-scan',
+      'Let Aikido fail when new exposed secrets have been detected...'
+    )
     .addOption(
       new Option(
         '--minimum-severity-level <level>',

package/src/index.ts

@@ -19,7 +19,7 @@ program
   .description(
     'CLI api client to easily integrate the Aikido public CI API into custom deploy scripts'
   )
-  .version('1.0.3');
+  .version('1.0.4');
 
 // Load in all app commands and set them up in the `program` instance
 apiKey.cliSetup(program);

package/src/output.ts

@@ -30,43 +30,38 @@ export const outputError = (message: string, exitCode: number = 1): void => {
 };
 
 export const outputHttpError = (axiosError: AxiosError): void => {
-  if (axiosError.code === 'ECONNREFUSED') {
-    outputError(
-      `Could not connect to Aikido API (${axiosError.message}). Please verify your network settings`
-    );
-  } else if (
-    axiosError.response?.status &&
-    axiosError.response?.status === 401
-  ) {
-    outputError(
-      'Request failed. The provided api key is most likely no longer valid and has been rotated or revoked. Visit https://app.aikido.dev/settings/integrations/continuous-integration to generate a new key.'
-    );
-  } else if (
-    axiosError.response?.status &&
-    axiosError.response?.status === 403
-  ) {
-    outputError(
-      'Could not authenticate with the Aikido API. Please verify your Aikdio API key.'
-    );
-  } else if (
-    axiosError.response?.status &&
-    axiosError.response?.status === 500
-  ) {
-    outputError('Something went wrong contacting the Aikido API.');
-  }
+  outputDebug(axiosError);
 
-  const statusStr = axiosError.response?.status
-    ? ` (${axiosError.response?.status})`
-    : '';
+  if (axiosError.isAxiosError) {
+    if (axiosError.response) {
+      const statusStr = `${axiosError.response.status} ${axiosError.response.statusText}`;
+      switch (axiosError.response.status) {
+        case 401:
+          return outputError(
+            `${statusStr}: The provided api key is most likely no longer valid and has been rotated or revoked. Visit https://app.aikido.dev/settings/integrations/continuous-integration to generate a new key.`
+          );
+        case 403:
+          return outputError(
+            `${statusStr}: Could not authenticate with the Aikido API. Please verify your Aikdio API key.`
+          );
+        case 500:
+          return outputError(
+            `${statusStr}: Something went wrong contacting the Aikido API. Please try again later.`
+          );
+        default:
+          return outputError(
+            `${statusStr}: ${
+              axiosError.response.data ?? ''
+            } Please contact us if this problem persists.`
+          );
+      }
+    }
 
-  if (axiosError.response) {
-    outputDebug(axiosError.response?.status);
-    outputDebug(axiosError.response?.headers);
-    outputDebug(axiosError.response?.data);
+    return outputError(`${axiosError.name}: ${axiosError.message}`);
   }
 
-  outputError(
-    `Something unexpected went wrong${statusStr}... Please contact us if this problem persists.`
+  return outputError(
+    'Unexpected error occurred. Please contact us if this problem persists.'
   );
 };