@aikidosec/ci-api-client 1.0.1 → 1.0.2

package/src/aikidoApi.ts

@@ -1,148 +1,148 @@
-import axios from 'axios';
-import { getApiKey } from './configuration.js';
-import { outputDebug } from './output.js';
-
-const getApiUrl = () => process.env.AIKIDO_API || 'https://app.aikido.dev';
-const getApiHeaders = () => ({
-  'Content-Type': 'application/json',
-  'X-AIK-API-SECRET': getApiKey(),
-});
-
-// #region Scan start
-export type TScanApiOptions = {
-  repository_id?: string | number;
-  base_commit_id?: string;
-  head_commit_id?: string;
-  branch_name?: string;
-  pull_request_metadata?: {
-    title?: string;
-    url?: string;
-  };
-  self_managed_scanners?: string[];
-  fail_on_dependency_scan?: boolean;
-  fail_on_sast_scan?: boolean;
-  fail_on_iac_scan?: boolean;
-  minimum_severity?: string;
-  version: string;
-};
-
-export type TStartScanResult = {
-  scan_id: number;
-};
-
-// Start a scan with options (see: startScanSchema)
-// and return the data
-export async function startScan(
-  data: TScanApiOptions
-): Promise<TStartScanResult> {
-  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/repository`;
-  const requestConfig = {
-    method: 'POST',
-    data,
-    headers: getApiHeaders(),
-  };
-
-  outputDebug(`API request: ${requestUrl}`);
-  outputDebug(requestConfig);
-
-  const resultData = (await axios(requestUrl, requestConfig)).data;
-  outputDebug(resultData);
-
-  return resultData;
-}
-// #endregion
-
-// #region Scan polling
-export type TPollIsScanningResult = {
-  all_scans_completed: boolean;
-  dependency_scan_completed: boolean;
-  sast_scan_completed: boolean;
-  iac_scan_completed: boolean;
-  sbom_scan_completed?: boolean;
-};
-
-type TPollScanCompletedOptions = {
-  gate_passed: boolean;
-};
-
-type TPollScanFeatureBranchCompletedOptions = {
-  new_issues_found: number;
-  new_dependency_issues_found: number;
-  new_sast_issues_found: number;
-  new_iac_issues_found: number;
-  diff_url: string;
-};
-
-type TPollScanDefaultBranchCompletedOptions = {
-  open_issues_found: number;
-  issue_links: string[];
-};
-
-export type TPollScanFeatureBranchCompletedResult = TPollIsScanningResult &
-  TPollScanCompletedOptions &
-  TPollScanFeatureBranchCompletedOptions;
-
-export type TPollScanCompletedDefaultBranchResult = TPollIsScanningResult &
-  TPollScanCompletedOptions &
-  TPollScanDefaultBranchCompletedOptions;
-
-export async function pollScanStatus(
-  scanId: number
-): Promise<
-  | TPollIsScanningResult
-  | TPollScanFeatureBranchCompletedResult
-  | TPollScanCompletedDefaultBranchResult
-> {
-  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/repository`;
-  const requestConfig = {
-    method: 'GET',
-    params: { scan_id: scanId },
-    headers: getApiHeaders(),
-  };
-
-  outputDebug(`API request: ${requestUrl}`);
-  outputDebug(requestConfig);
-
-  const resultData = (await axios(requestUrl, requestConfig)).data;
-  outputDebug(resultData);
-
-  return resultData;
-}
-// #endregion
-
-// #region Upload custom result
-export enum TUploadPayloadType {
-  Checkov = 'checkov',
-  JsonSbom = 'json-sbom',
-}
-
-export type TUploadApiOptions = {
-  scan_id?: number;
-  repository_id: string | number;
-  container_image_name?: string;
-  payload_type: TUploadPayloadType;
-  payload: string;
-};
-
-export type TUploadResult = {
-  success: number;
-};
-
-export async function uploadCustomScanResult(
-  data: TUploadApiOptions
-): Promise<TUploadResult> {
-  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/custom`;
-  const requestConfig = {
-    method: 'POST',
-    data,
-    headers: getApiHeaders(),
-  };
-
-  outputDebug(`API request: ${requestUrl}`);
-  outputDebug(requestConfig);
-
-  const resultData = (await axios(requestUrl, requestConfig)).data;
-  outputDebug(resultData);
-
-  return resultData;
-}
+import axios from 'axios';
+import { getApiKey } from './configuration.js';
+import { outputDebug } from './output.js';
+
+const getApiUrl = () => process.env.AIKIDO_API || 'https://app.aikido.dev';
+const getApiHeaders = () => ({
+  'Content-Type': 'application/json',
+  'X-AIK-API-SECRET': getApiKey(),
+});
+
+// #region Scan start
+export type TScanApiOptions = {
+  repository_id?: string | number;
+  base_commit_id?: string;
+  head_commit_id?: string;
+  branch_name?: string;
+  pull_request_metadata?: {
+    title?: string;
+    url?: string;
+  };
+  self_managed_scanners?: string[];
+  fail_on_dependency_scan?: boolean;
+  fail_on_sast_scan?: boolean;
+  fail_on_iac_scan?: boolean;
+  minimum_severity?: string;
+  version: string;
+};
+
+export type TStartScanResult = {
+  scan_id: number;
+};
+
+// Start a scan with options (see: startScanSchema)
+// and return the data
+export async function startScan(
+  data: TScanApiOptions
+): Promise<TStartScanResult> {
+  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/repository`;
+  const requestConfig = {
+    method: 'POST',
+    data,
+    headers: getApiHeaders(),
+  };
+
+  outputDebug(`API request: ${requestUrl}`);
+  outputDebug(requestConfig);
+
+  const resultData = (await axios(requestUrl, requestConfig)).data;
+  outputDebug(resultData);
+
+  return resultData;
+}
+// #endregion
+
+// #region Scan polling
+export type TPollIsScanningResult = {
+  all_scans_completed: boolean;
+  dependency_scan_completed: boolean;
+  sast_scan_completed: boolean;
+  iac_scan_completed: boolean;
+  sbom_scan_completed?: boolean;
+};
+
+type TPollScanCompletedOptions = {
+  gate_passed: boolean;
+};
+
+type TPollScanFeatureBranchCompletedOptions = {
+  new_issues_found: number;
+  new_dependency_issues_found: number;
+  new_sast_issues_found: number;
+  new_iac_issues_found: number;
+  diff_url: string;
+};
+
+type TPollScanDefaultBranchCompletedOptions = {
+  open_issues_found: number;
+  issue_links: string[];
+};
+
+export type TPollScanFeatureBranchCompletedResult = TPollIsScanningResult &
+  TPollScanCompletedOptions &
+  TPollScanFeatureBranchCompletedOptions;
+
+export type TPollScanCompletedDefaultBranchResult = TPollIsScanningResult &
+  TPollScanCompletedOptions &
+  TPollScanDefaultBranchCompletedOptions;
+
+export async function pollScanStatus(
+  scanId: number
+): Promise<
+  | TPollIsScanningResult
+  | TPollScanFeatureBranchCompletedResult
+  | TPollScanCompletedDefaultBranchResult
+> {
+  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/repository`;
+  const requestConfig = {
+    method: 'GET',
+    params: { scan_id: scanId },
+    headers: getApiHeaders(),
+  };
+
+  outputDebug(`API request: ${requestUrl}`);
+  outputDebug(requestConfig);
+
+  const resultData = (await axios(requestUrl, requestConfig)).data;
+  outputDebug(resultData);
+
+  return resultData;
+}
+// #endregion
+
+// #region Upload custom result
+export enum TUploadPayloadType {
+  Checkov = 'checkov',
+  JsonSbom = 'json-sbom',
+}
+
+export type TUploadApiOptions = {
+  scan_id?: number;
+  repository_id: string | number;
+  container_image_name?: string;
+  payload_type: TUploadPayloadType;
+  payload: string;
+};
+
+export type TUploadResult = {
+  success: number;
+};
+
+export async function uploadCustomScanResult(
+  data: TUploadApiOptions
+): Promise<TUploadResult> {
+  const requestUrl = `${getApiUrl()}/api/integrations/continuous_integration/scan/custom`;
+  const requestConfig = {
+    method: 'POST',
+    data,
+    headers: getApiHeaders(),
+  };
+
+  outputDebug(`API request: ${requestUrl}`);
+  outputDebug(requestConfig);
+
+  const resultData = (await axios(requestUrl, requestConfig)).data;
+  outputDebug(resultData);
+
+  return resultData;
+}

package/src/commands/apiKey.ts

@@ -1,30 +1,33 @@
-import { Argument, Command } from 'commander';
-import { setApiKey } from '../configuration.js';
-import { outputError, outputLog } from '../output.js';
-
-function cli(apiKey: string): void {
-  if (apiKey && apiKey.trim().length != 128) {
-    outputError('That does not seem right, please verify your api key');
-  }
-
-  setApiKey(apiKey);
-  outputLog(
-    apiKey
-      ? 'Your new Aikido API key has been set'
-      : 'Your Aikido API key has been removed'
-  );
-}
-
-export const cliSetup = (program: Command): Command =>
-  program
-    .command('apikey')
-    .addArgument(
-      new Argument(
-        '<key>',
-        'Your Aikido public CI API key. See also: https://app.aikido.dev/settings/integrations/continuous-integration. To remove your apikey, leave the <key> argument value empty.'
-      ).argOptional()
-    )
-    .description('Set (or remove) your Aikido public CI API key.')
-    .action(cli);
-
-export default { cli, cliSetup };
+import { Argument, Command } from 'commander';
+import { setApiKey } from '../configuration.js';
+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;
+  if (apiKey && !isValidApiKey) {
+    outputError('That does not seem right, please verify your api key');
+  }
+
+  setApiKey(apiKey);
+  outputLog(
+    apiKey
+      ? 'Your new Aikido API key has been set'
+      : 'Your Aikido API key has been removed'
+  );
+}
+
+export const cliSetup = (program: Command): Command =>
+  program
+    .command('apikey')
+    .addArgument(
+      new Argument(
+        '<key>',
+        'Your Aikido public CI API key. See also: https://app.aikido.dev/settings/integrations/continuous-integration. To remove your apikey, leave the <key> argument value empty.'
+      ).argOptional()
+    )
+    .description('Set (or remove) your Aikido public CI API key.')
+    .action(cli);
+
+export default { cli, cliSetup };