aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/apps/settings/encryption/GenerateSecretKeyForm.js
blob: 79166acc968da8a4f0aa9fd59dd67ce411ecaa98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 * SonarQube
 * Copyright (C) 2009-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import React from 'react';
import PropTypes from 'prop-types';

export default class GenerateSecretKeyForm extends React.PureComponent {
  static propTypes = {
    secretKey: PropTypes.string,
    generateSecretKey: PropTypes.func.isRequired
  };

  handleSubmit(e) {
    e.preventDefault();
    this.props.generateSecretKey();
  }

  render() {
    return (
      <div id="generate-secret-key-form-container">
        {this.props.secretKey != null
          ? <div>
              <div className="big-spacer-bottom">
                <h3 className="spacer-bottom">Secret Key</h3>
                <input
                  id="secret-key"
                  className="input-large"
                  type="text"
                  readOnly={true}
                  value={this.props.secretKey}
                />
              </div>

              <h3 className="spacer-bottom">How To Use</h3>

              <ul className="list-styled markdown">
                <li className="spacer-bottom">
                  Store the secret key in the file <code>~/.sonar/sonar-secret.txt</code> of the
                  server. This file can be relocated by defining the property{' '}
                  <code>sonar.secretKeyPath</code> in <code>conf/sonar.properties</code>
                </li>
                <li className="spacer-bottom">
                  Restrict access to this file by making it readable and by owner only
                </li>
                <li className="spacer-bottom">
                  Restart the server if the property <code>sonar.secretKeyPath</code> has been set
                  or changed.
                </li>
                <li className="spacer-bottom">
                  Copy this file on all the machines that execute code inspection. Define the{' '}
                  property <code>sonar.secretKeyPath</code> on those machines if the path is not{' '}
                  <code>~/.sonar/sonar-secret.txt</code>.
                </li>
                <li>
                  For each property that you want to encrypt, generate the encrypted value and{' '}
                  replace the original value wherever it is stored (configuration files, command
                  lines).
                </li>
              </ul>
            </div>
          : <div>
              <p className="spacer-bottom">
                Secret key is required to be able to encrypt properties.{' '}
                <a href="https://redirect.sonarsource.com/doc/settings-encryption.html">
                  More information
                </a>
              </p>

              <form id="generate-secret-key-form" onSubmit={e => this.handleSubmit(e)}>
                <button>Generate Secret Key</button>
              </form>
            </div>}
      </div>
    );
  }
}