From 035145acb58ae5fd0c5de73dbdd16be0515e79f1 Mon Sep 17 00:00:00 2001 From: Teryk Bellahsene Date: Mon, 5 Sep 2016 18:18:48 +0200 Subject: [PATCH] SONAR-7983 Create WS api/settings/check_secret_key --- .../setting/ws/CheckSecretKeyAction.java | 58 +++++++++ .../server/setting/ws/SettingsWsModule.java | 1 + .../setting/ws/check_secret_key-example.json | 3 + .../setting/ws/CheckSecretKeyActionTest.java | 114 ++++++++++++++++++ .../setting/ws/SettingsWsModuleTest.java | 2 +- sonar-ws/src/main/protobuf/ws-settings.proto | 5 + 6 files changed, 182 insertions(+), 1 deletion(-) create mode 100644 server/sonar-server/src/main/java/org/sonar/server/setting/ws/CheckSecretKeyAction.java create mode 100644 server/sonar-server/src/main/resources/org/sonar/server/setting/ws/check_secret_key-example.json create mode 100644 server/sonar-server/src/test/java/org/sonar/server/setting/ws/CheckSecretKeyActionTest.java diff --git a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/CheckSecretKeyAction.java b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/CheckSecretKeyAction.java new file mode 100644 index 00000000000..32f475b8850 --- /dev/null +++ b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/CheckSecretKeyAction.java @@ -0,0 +1,58 @@ +/* + * 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 org.sonar.server.setting.ws; + +import org.sonar.api.config.Settings; +import org.sonar.api.server.ws.Request; +import org.sonar.api.server.ws.Response; +import org.sonar.api.server.ws.WebService; +import org.sonar.server.user.UserSession; +import org.sonarqube.ws.Settings.CheckSecretKeyWsResponse; + +import static org.sonar.core.permission.GlobalPermissions.SYSTEM_ADMIN; +import static org.sonar.server.ws.WsUtils.writeProtobuf; + +public class CheckSecretKeyAction implements SettingsWsAction { + private final Settings settings; + private final UserSession userSession; + + public CheckSecretKeyAction(Settings settings, UserSession userSession) { + this.settings = settings; + this.userSession = userSession; + } + + @Override + public void define(WebService.NewController context) { + context.createAction("check_secret_key") + .setDescription("Check if a secret key is available") + .setSince("6.1") + .setInternal(true) + .setResponseExample(getClass().getResource("check_secret_key-example.json")) + .setHandler(this); + } + + @Override + public void handle(Request request, Response response) throws Exception { + userSession.checkPermission(SYSTEM_ADMIN); + + writeProtobuf(CheckSecretKeyWsResponse.newBuilder().setSecretKeyAvailable(settings.getEncryption().hasSecretKey()).build(), request, response); + } +} diff --git a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SettingsWsModule.java b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SettingsWsModule.java index e8bbb1d7816..b81ac302d98 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SettingsWsModule.java +++ b/server/sonar-server/src/main/java/org/sonar/server/setting/ws/SettingsWsModule.java @@ -34,6 +34,7 @@ public class SettingsWsModule extends Module { ResetAction.class, EncryptAction.class, GenerateSecretKeyAction.class, + CheckSecretKeyAction.class, SettingsUpdater.class); } } diff --git a/server/sonar-server/src/main/resources/org/sonar/server/setting/ws/check_secret_key-example.json b/server/sonar-server/src/main/resources/org/sonar/server/setting/ws/check_secret_key-example.json new file mode 100644 index 00000000000..38ce4256389 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/setting/ws/check_secret_key-example.json @@ -0,0 +1,3 @@ +{ + "secretKeyAvailable": true +} diff --git a/server/sonar-server/src/test/java/org/sonar/server/setting/ws/CheckSecretKeyActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/setting/ws/CheckSecretKeyActionTest.java new file mode 100644 index 00000000000..00c55ea695d --- /dev/null +++ b/server/sonar-server/src/test/java/org/sonar/server/setting/ws/CheckSecretKeyActionTest.java @@ -0,0 +1,114 @@ +/* + * 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 org.sonar.server.setting.ws; + +import com.google.common.base.Throwables; +import java.io.File; +import java.io.IOException; +import org.apache.commons.io.FileUtils; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.junit.rules.TemporaryFolder; +import org.sonar.api.config.Encryption; +import org.sonar.api.config.Settings; +import org.sonar.api.server.ws.WebService; +import org.sonar.server.exceptions.ForbiddenException; +import org.sonar.server.tester.UserSessionRule; +import org.sonar.server.ws.TestRequest; +import org.sonar.server.ws.WsActionTester; +import org.sonarqube.ws.MediaTypes; +import org.sonarqube.ws.Settings.CheckSecretKeyWsResponse; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.sonar.core.permission.GlobalPermissions.QUALITY_PROFILE_ADMIN; +import static org.sonar.core.permission.GlobalPermissions.SYSTEM_ADMIN; +import static org.sonar.test.JsonAssert.assertJson; + +public class CheckSecretKeyActionTest { + @Rule + public ExpectedException expectedException = ExpectedException.none(); + @Rule + public UserSessionRule userSession = UserSessionRule.standalone().setGlobalPermissions(SYSTEM_ADMIN); + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + Settings settings = new Settings(); + Encryption encryption = settings.getEncryption(); + + CheckSecretKeyAction underTest = new CheckSecretKeyAction(settings, userSession); + + WsActionTester ws = new WsActionTester(underTest); + + @Test + public void json_example() throws IOException { + File secretKeyFile = temporaryFolder.newFile(); + FileUtils.writeStringToFile(secretKeyFile, "fCVFf/JHRi8Qwu5KLNva7g=="); + encryption.setPathToSecretKey(secretKeyFile.getAbsolutePath()); + + String result = ws.newRequest().execute().getInput(); + + assertJson(result).isSimilarTo(ws.getDef().responseExampleAsString()); + } + + @Test + public void false_when_no_secret_key() { + encryption.setPathToSecretKey("unknown/path/to_secret_key.txt"); + + CheckSecretKeyWsResponse result = call(); + + assertThat(result.getSecretKeyAvailable()).isFalse(); + } + + @Test + public void definition() { + WebService.Action definition = ws.getDef(); + + assertThat(definition.key()).isEqualTo("check_secret_key"); + assertThat(definition.isPost()).isFalse(); + assertThat(definition.isInternal()).isTrue(); + assertThat(definition.since()).isEqualTo("6.1"); + assertThat(definition.responseExampleAsString()).isNotEmpty(); + assertThat(definition.params()).hasSize(0); + } + + @Test + public void fail_if_insufficient_permissions() { + expectedException.expect(ForbiddenException.class); + + userSession.anonymous().setGlobalPermissions(QUALITY_PROFILE_ADMIN); + + call(); + } + + private CheckSecretKeyWsResponse call() { + TestRequest request = ws.newRequest() + .setMediaType(MediaTypes.PROTOBUF) + .setMethod("GET"); + + try { + return CheckSecretKeyWsResponse.parseFrom(request.execute().getInputStream()); + } catch (IOException e) { + throw Throwables.propagate(e); + } + } + +} diff --git a/server/sonar-server/src/test/java/org/sonar/server/setting/ws/SettingsWsModuleTest.java b/server/sonar-server/src/test/java/org/sonar/server/setting/ws/SettingsWsModuleTest.java index 627905526f9..19a40eb621b 100644 --- a/server/sonar-server/src/test/java/org/sonar/server/setting/ws/SettingsWsModuleTest.java +++ b/server/sonar-server/src/test/java/org/sonar/server/setting/ws/SettingsWsModuleTest.java @@ -29,6 +29,6 @@ public class SettingsWsModuleTest { public void verify_count_of_added_components() { ComponentContainer container = new ComponentContainer(); new SettingsWsModule().configure(container); - assertThat(container.size()).isEqualTo(10 + 2); + assertThat(container.size()).isEqualTo(11 + 2); } } diff --git a/sonar-ws/src/main/protobuf/ws-settings.proto b/sonar-ws/src/main/protobuf/ws-settings.proto index 910e57b57bd..df8e36059b5 100644 --- a/sonar-ws/src/main/protobuf/ws-settings.proto +++ b/sonar-ws/src/main/protobuf/ws-settings.proto @@ -39,6 +39,11 @@ message GenerateSecretKeyWsResponse { optional string secretKey = 1; } +// Response of GET api/settings/check_secret_key +message CheckSecretKeyWsResponse { + optional bool secretKeyAvailable = 1; +} + message Definition { optional string key = 1; optional string name = 2; -- 2.39.5