Primeros pasos
bitegarden Dependecy Check for SonarCloud™ requiere Java 8 o superior.
Guía rápida: genera un archivo con las vulnerabilidades de un reporte de Dependency Check para tu proyecto de SonarCloud™
Una vez que hayas descargado el producto tendrás un fichero "jar" auto ejecutable.
Simplemente ubícalo en tu sistema de ficheros y ejecuta el jar con la opción "--help" para ver todas las opciones disponibles:
java -jar bitegarden-dependency-check-for-sonarcloud.jar --help
El resultado debería mostrarte todas las opciones disponibles:
...
bitegarden Dependency Check for SonarCloud (1.0). Copyright (C) 2024 bitegarden. All rights reserved. www.bitegarden.com
Loading properties from command line (-Dname=value)... if found, it will override configuration file properties
No configuration found.
bitegarden Dependency Check for SonarCloud. Command Line usage:
java -Dconfig.file=PATH_TO_CONFIG_FILE -Dlicense.file=PATH_TO_LICENSE_FILE ... -jar bitegarden-dependency-check-for-sonarcloud-1.0.jar
config.file = path to properties file including all the parameters required to generate the reports.
This is optional. You can set all the properties through command line args using -DpropertyName=propertyValue
Note that if you use a config file and command line arguments, arguments will override config file
license.file = path to file with your license key provided by bitegarden.
By default a 14 days trial version will be used if license file is not provided
Mandatory properties:
dependency.check.file = path to Dependency-Check file. Compatible formats (JSON and XML)
sonar.organizationKey = your organization key used to create license.
Optional properties:
vulnerabilities.file.path = path to project file to add new vulnerabilities in SonarCloud
output = File name for the generated report (Without .json extension)
...
Todas las propiedades pueden proporcionarse a través de la línea de comandos como argumentos del sistema usando "-D" o a través de un fichero
de configuración personalizado.
Si utilizas un fichero de configuración personalizado deberás ejecutar la aplicación con el argumento "-Dconfig.file" proporcionando la ruta a tu fichero
de propiedades con la configuración:
java -Dconfig.file=config.properties -jar bitegarden-dependency-check-for-sonarcloud.jar --help
Si lo prefieres puedes pasar todas las opciones a través de la línea de comandos con "-D":
java -Ddependency.check.file=vulnerabilities.json -Dsonar.organitzationKey=bitegarden -jar bitegarden-dependency-check-for-sonarcloud.jar --help
Si una opción está definida en ambos sitios (un fichero de configuración y un argumento por línea de comandos) se usará el valor proporcionado en la línea de comandos.
De esta forma puedes tener un fichero de configuración común con las propiedades compartidas (como por ejemplo sonar.organizationKey) y después simplemente usar los argumentos
para las opciones concretas como es “dependency.check.file”, por ejemplo.
Por defecto cuando descargas el producto podrás utilizar durante 14 días en modo evaluación.
Una vez que la evaluación haya terminado, necesitarás adquirir el producto y obtener un clave de licencia válida.
La clave de licencia se proporciona en un fichero de texto. Para usar este fichero de licencia debes establecer
la propiedad “license.file” con la ruta hasta el fichero de licencia en tu fichero de configuración (o a través de un argumento por línea de comandos).
La licencia está ligada a la clave de tu organización.
Aquí tienes un ejemplo para generar un informe usando una licencia del producto a través de un argumento por línea de comandos: