Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Encryption is mostly used to remove clear passwords from settings (database or SCM credentials for instance). The implemented solution is based on a symetric key algorithm. The key point is that the secret key is stored in a secured file on disk. This file must owned by and readable only by the system account that runs the SonarQube server, the analysis with SonarQube Runner, SonarQube Ant Task, Maven or from the Continuous Integration server.

The algorithm is AES 128 bits. Note that 256 bits cipher is not used because it's not supported by default on all Java Virtual Machines (see this article).

1. Generate the secret key

A unique secret key must be shared between all parts of the SonarQube infrastructure (server and analyzers). To generate it, go to Settings > Configuration > General Settings > Encryption and click on Generate secret key:

2. Store the secret key on the SonarQube server

  1. Copy the generated secret key to a file:

    sonar-secret.txt



  2. Store this file on the machine hosting the SonarQube server (default location:  ~/.sonar/sonar-secret.txt). If you want to store it somewhere else, set its path through the sonar.secretKeyPath property in SONARQUBE_HOME/conf/sonar.properties:

    SONARQUBE_HOME/conf/sonar.properties



  3. Restrict its access to the system account running the SonarQube server (ownership and read-access only).
  4. Restart your SonarQube server.

3. Generate the encrypted values of your settings

Go back to Settings > Configuration > General Settings > Encryption and generate the encrypted values of your settings:

4. Use these encrypted values

Server side

Simply copy these encrypted values into SONARQUBE_HOME/conf/sonar.properties:

SONARQUBE_HOME/conf/sonar.properties

Restart your SonarQube server.

Batch side

Copy the secret key file to the machine running the analysis.

Copy these encrypted values into the analyzer configuration file: sonar-runner.properties, settings.xml, etc. Do not forget to define the path to your secret key as well.

sonar-runner.properties
settings.xml
Icon

The sonar.password property is only encryptable since SonarQube 3.7.

  • No labels