This an an archived version of the documentation for SonarQube version 4.3 and below.
See https://docs.sonarqube.org/display/SONAR/Documentation for current functionality
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 > General Settings > Security > Encryption and click on Generate secret key:
2. Store the secret key on the SonarQube server
Copy the generated secret key to a file:
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.secretKeyPathproperty in SONARQUBE_HOME/conf/sonar.properties:
- Restrict its access to the system account running the SonarQube server (ownership and read-access only).
- Restart your SonarQube server.
3. Generate the encrypted values of your settings
Go back to Settings > General Settings > Security > Encryption and generate the encrypted values of your settings:
4. Use these encrypted values
Simply copy these encrypted values into SONARQUBE_HOME/conf/sonar.properties:
Restart your SonarQube server.
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.
Note also that the Maven encryption mechanism can be used to encrypt password properties since SonarQube 4.3.