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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact 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.
*/
package it.serverSystem;
import com.sonar.orchestrator.Orchestrator;
import it.Category4Suite;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;
import okhttp3.CacheControl;
import okhttp3.Response;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static util.ItUtils.call;
public class HttpHeadersTest {
@ClassRule
public static final Orchestrator orchestrator = Category4Suite.ORCHESTRATOR;
private static String JS_HASH;
@BeforeClass
public static void setUp() throws Exception {
JS_HASH = getJsHash();
}
@Test
public void verify_headers_of_base_url() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/");
verifySecurityHeaders(response);
verifyContentType(response, "text/html;charset=utf-8");
// SONAR-6964
assertNoCacheInBrowser(response);
}
@Test
public void verify_headers_of_ws() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/api/issues/search");
verifySecurityHeaders(response);
verifyContentType(response, "application/json");
assertNoCacheInBrowser(response);
}
@Test
public void verify_headers_of_ruby_ws() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/api/resources/index");
verifySecurityHeaders(response);
verifyContentType(response, "application/json;charset=utf-8");
assertNoCacheInBrowser(response);
}
@Test
public void verify_headers_of_images() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/images/logo.svg");
verifySecurityHeaders(response);
verifyContentType(response, "image/svg+xml");
assertCacheInBrowser(response);
}
@Test
public void verify_headers_of_css() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/css/sonar." + JS_HASH + ".css");
verifySecurityHeaders(response);
verifyContentType(response, "text/css");
assertCacheInBrowser(response);
}
@Test
public void verify_headers_of_js() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/js/app." + JS_HASH + ".js");
verifySecurityHeaders(response);
verifyContentType(response, "application/javascript");
}
@Test
public void verify_headers_of_images_provided_by_plugins() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/static/uiextensionsplugin/cute.jpg");
verifySecurityHeaders(response);
verifyContentType(response, "image/jpeg");
}
@Test
public void verify_headers_of_js_provided_by_plugins() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/static/uiextensionsplugin/extension.js");
verifySecurityHeaders(response);
verifyContentType(response, "application/javascript");
}
@Test
public void verify_headers_of_html_provided_by_plugins() throws Exception {
Response response = call(orchestrator.getServer().getUrl() + "/static/uiextensionsplugin/file.html");
verifySecurityHeaders(response);
verifyContentType(response, "text/html");
}
private static void assertCacheInBrowser(Response httpResponse) {
CacheControl cacheControl = httpResponse.cacheControl();
assertThat(cacheControl.mustRevalidate()).isFalse();
assertThat(cacheControl.noCache()).isFalse();
assertThat(cacheControl.noStore()).isFalse();
}
private static void assertNoCacheInBrowser(Response httpResponse) {
CacheControl cacheControl = httpResponse.cacheControl();
assertThat(cacheControl.mustRevalidate()).isTrue();
assertThat(cacheControl.noCache()).isTrue();
assertThat(cacheControl.noStore()).isTrue();
}
/**
* SONAR-8247
*/
private static void verifySecurityHeaders(Response httpResponse) {
assertThat(httpResponse.isSuccessful()).as("Code is %s", httpResponse.code()).isTrue();
assertThat(httpResponse.headers().get("X-Frame-Options")).isEqualTo("SAMEORIGIN");
assertThat(httpResponse.headers().get("X-XSS-Protection")).isEqualTo("1; mode=block");
assertThat(httpResponse.headers().get("X-Content-Type-Options")).isEqualTo("nosniff");
}
private static void verifyContentType(Response httpResponse, String expectedContentType) {
assertThat(httpResponse.headers().get("Content-Type")).isEqualTo(expectedContentType);
}
/**
* Every JS and CSS files contains a hash between the file name and the extension.
*/
private static String getJsHash() throws IOException {
File cssFolder = new File(orchestrator.getServer().getHome(), "web/css");
Optional<Path> cssPath = Files.list(cssFolder.toPath()).map(Path::getFileName).findFirst();
if (cssPath.isPresent()) {
String fileName = cssPath.get().toFile().getName();
return fileName.replace("sonar.", "").replace(".css", "");
}
throw new IllegalStateException("sonar.css hasn't been found");
}
}
|
