@aikidosec/ci-api-client - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

CONTRIBUTING.md

@@ -0,0 +0,0 @@ # Contributing to aikido-api-client

lib/aikidoApi.d.ts

@@ -14,2 +14,3 @@ export type TScanApiOptions = {
     fail_on_iac_scan?: boolean;
+    fail_on_secrets_scan?: boolean;
     minimum_severity?: string;
@@ -27,2 +28,3 @@ version: string;
     iac_scan_completed: boolean;
+    secrets_scan_completed: boolean;
     sbom_scan_completed?: boolean;
@@ -38,2 +40,3 @@ };
     new_iac_issues_found: number;
+    new_leaked_secret_issues_found: number;
     diff_url: string;
@@ -40,0 +43,0 @@ };

lib/commands/scan.d.ts

@@ -24,2 +24,3 @@ import { Command } from 'commander';
     failOnSastScan?: boolean;
+    failOnSecretsScan?: boolean;
     failOnIacScan?: boolean;
@@ -26,0 +27,0 @@ minimumSeverityLevel?: string;

lib/commands/scan.js

@@ -147,2 +147,5 @@ import chalk from 'chalk';
     }
+    if (userCliOptions.failOnSecretsScan != undefined) {
+        apiOptions.fail_on_secrets_scan = userCliOptions.failOnSecretsScan;
+    }
     if (userCliOptions.minimumSeverityLevel) {
@@ -186,2 +189,3 @@ apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
     .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']))
@@ -188,0 +192,0 @@ .addOption(new Option('--poll-interval [interval]', 'The poll interval when checking for an updated scan result')

package.json

 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "CLI api client to easily integrate the Aikido public CI API into custom deploy scripts",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -34,3 +34,3 @@ # Aikido Security CI API client
 ```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>
 ```
@@ -42,3 +42,3 @@
 
-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.
 
@@ -45,0 +45,0 @@ ```sh

RELEASING.md

@@ -0,0 +0,0 @@ # Releasing

src/aikidoApi.ts

@@ -25,2 +25,3 @@ import axios from 'axios';
   fail_on_iac_scan?: boolean;
+  fail_on_secrets_scan?: boolean;
   minimum_severity?: string;
@@ -62,2 +63,3 @@ version: string;
   iac_scan_completed: boolean;
+  secrets_scan_completed: boolean;
   sbom_scan_completed?: boolean;
@@ -75,2 +77,3 @@ };
   new_iac_issues_found: number;
+  new_leaked_secret_issues_found: number;
   diff_url: string;
@@ -77,0 +80,0 @@ };

src/commands/apiKey.ts

@@ -0,0 +0,0 @@ import { Argument, Command } from 'commander';

src/commands/scan.ts

@@ -62,2 +62,3 @@ import chalk from 'chalk';
   failOnSastScan?: boolean;
+  failOnSecretsScan?: boolean;
   failOnIacScan?: boolean;
@@ -275,2 +276,5 @@ minimumSeverityLevel?: string;
   }
+  if (userCliOptions.failOnSecretsScan != undefined) {
+    apiOptions.fail_on_secrets_scan = userCliOptions.failOnSecretsScan;
+  }
   if (userCliOptions.minimumSeverityLevel) {
@@ -358,2 +362,6 @@ apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
     )
+    .option(
+      '--fail-on-secrets-scan',
+      'Let Aikido fail when new exposed secrets have been detected...'
+    )
     .addOption(
@@ -360,0 +368,0 @@ new Option(

src/commands/upload.ts

@@ -0,0 +0,0 @@ import { Argument, Command, InvalidArgumentError, Option } from 'commander';

src/configuration.ts

@@ -0,0 +0,0 @@ import Configstore from 'configstore';

src/index.ts

@@ -0,0 +0,0 @@ #!/usr/bin/env node

src/output.ts

@@ -0,0 +0,0 @@ import ora, { Ora } from 'ora';

tsconfig.json

@@ -0,0 +0,0 @@ {

No alert changes

Improved metrics

Lines of code

1435

increased by1.34%

Worsened metrics

Total package byte prevSize

58826

decreased by-0.49%

No dependency changes