The Aikido Security Local Scanner is a tool that enables you to perform Aikido Security scans within your environment, ensuring your code never leaves your premises. The scans take place locally, and the results are then uploaded to the Aikido Security platform. This setup allows you to scan any repos locally own your own machine.
Prerequisites
Ensure that you have Docker installed before proceeding.
How to set up Local Scanning
Prerequisite: make sure to have created an account that allows for Local Scanning. More information on creating a Local Scanning Account.
1. Get your authentication token
Go to the Local Scanner setup page
Generate an authentication token and copy. Note that you will only be able to view this token once.
Add this token as argument
--apikeywhen running the Local Scanner in your project .
2. Running the Local Scanner
Now all that is left to spin up a container and scan your repository. Navigate to the root of your repository and run the following command.
If you are using the command prompt:
docker run --rm -v "%cd%:/my-app" aikidosecurity/local-scanner scan /my-app --apikey AIK_CI_xxx --repositoryname RepoName --branchname main
If you are using Powershell:
docker run --rm -v "{PWD}:/my-app" aikidosecurity/local-scanner scan /my-app --apikey AIK_CI_xxx --repositoryname RepoName --branchname main
By default all scanners will be executed, if you'd like to run only a selection of scanners, you can do so by supplying the scanner names --scanners option. More information on CLI options can be found here.
4. Check your scanning results
After your first scan is done, you can go to the Aikido Feed to check out your results. A repository with the name you specified will have been created, containing all results from the scanning.