Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add authorization settings for API #1017

Merged
merged 3 commits into from
May 20, 2024
Merged

Add authorization settings for API #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21fcad0
Add authorization for file entry APIs
imbyungjun May 7, 2024
86b9983
Changed not to expose other users' perftest running information
imbyungjun May 7, 2024
a394fd1
Add authorization for perftest APIs
imbyungjun May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...nder-controller/src/main/java/org/ngrinder/perftest/controller/PerfTestApiController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;

import java.net.URL;
Expand Down Expand Up @@ -74,6 +75,7 @@
@RestController
@RequestMapping("/perftest/api")
@RequiredArgsConstructor
@PreAuthorize("hasAnyRole('A', 'S', 'U')")
public class PerfTestApiController {

private final PerfTestService perfTestService;
Expand Down Expand Up @@ -337,6 +339,7 @@ public Map<String, Object> refreshTestRunning(User user, @PathVariable long id)
}

@GetMapping("/{id}/detail_report")
@PreAuthorize("permitAll")
public Map<String, Object> getReport(@PathVariable long id) {
Map<String, Object> model = newHashMap();
model.put("test", perfTestService.getOne(id));
Expand Down Expand Up @@ -531,7 +534,7 @@ public Map<String, Object> getStatuses(User user, @RequestParam(defaultValue = "
.collect(toList());

return buildMap(
"perfTestInfo", perfTestService.getCurrentPerfTestStatistics(),
"runningTestsCount", perfTestService.getCurrentPerfTestStatistics().size(),
"status", statuses
);
}
Expand Down Expand Up @@ -601,6 +604,7 @@ public List<String> getLogs(User user, @PathVariable long id) {
* @return perf test result list.
*/
@GetMapping({"/{id}/perf", "/{id}/graph"})
@PreAuthorize("permitAll")
public Map<String, Object> getPerfGraph(@PathVariable long id,
@RequestParam(defaultValue = "") String dataType,
@RequestParam(defaultValue = "false") boolean onlyTotal,
Expand Down Expand Up @@ -630,6 +634,7 @@ private Map<String, Object> getPerfGraphData(Long id, String[] dataTypes, boolea
* @return json message
*/
@GetMapping("/{id}/monitor")
@PreAuthorize("permitAll")
public Map<String, Object> getMonitorGraph(@PathVariable long id,
@RequestParam String targetIP, @RequestParam int imgWidth) {
int interval = perfTestService.getMonitorGraphInterval(id, targetIP, imgWidth);
Expand All @@ -649,6 +654,7 @@ public Map<String, Object> getMonitorGraph(@PathVariable long id,
* @return json message
*/
@GetMapping("/{id}/plugin/{plugin}")
@PreAuthorize("permitAll")
public Map<String, Object> getPluginGraph(@PathVariable long id,
@PathVariable String plugin,
@RequestParam String kind,
Expand Down
6 changes: 6 additions & 0 deletions ngrinder-controller/src/main/java/org/ngrinder/perftest/controller/PerfTestController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.ngrinder.infra.spring.RemainedPath;
import org.ngrinder.model.*;
import org.ngrinder.perftest.service.PerfTestService;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;
Expand All @@ -44,6 +45,7 @@
@RequestMapping("/perftest")
@GlobalControllerModel
@RequiredArgsConstructor
@PreAuthorize("hasAnyRole('A', 'S', 'U')")
public class PerfTestController {

private final PerfTestService perfTestService;
Expand Down Expand Up @@ -150,6 +152,7 @@ public void showLog(User user, @PathVariable("id") long id, @RemainedPath String
* @return perftest/detail_report
*/
@GetMapping({"/{id}/detail_report", /* for backward compatibility */"/{id}/report"})
@PreAuthorize("permitAll")
public String getReport(@PathVariable long id) {
return "app";
}
Expand All @@ -162,6 +165,7 @@ public String getReport(@PathVariable long id) {
*/
@SuppressWarnings("UnusedParameters")
@GetMapping("/{id}/detail_report/perf")
@PreAuthorize("permitAll")
public String getDetailPerfReport(@PathVariable("id") long id) {
return "perftest/detail_report/perf";
}
Expand All @@ -176,6 +180,7 @@ public String getDetailPerfReport(@PathVariable("id") long id) {
*/
@SuppressWarnings("UnusedParameters")
@GetMapping("/{id}/detail_report/monitor")
@PreAuthorize("permitAll")
public String getDetailMonitorReport(@PathVariable("id") long id, @RequestParam("targetIP") String targetIP,
ModelMap modelMap) {
modelMap.addAttribute("targetIP", targetIP);
Expand All @@ -192,6 +197,7 @@ public String getDetailMonitorReport(@PathVariable("id") long id, @RequestParam(
*/
@SuppressWarnings("UnusedParameters")
@GetMapping("/{id}/detail_report/plugin/{plugin}")
@PreAuthorize("permitAll")
public String getDetailPluginReport(@PathVariable("id") long id,
@PathVariable("plugin") String plugin, @RequestParam("kind") String kind, ModelMap modelMap) {
modelMap.addAttribute("plugin", plugin);
Expand Down
2 changes: 2 additions & 0 deletions ngrinder-controller/src/main/java/org/ngrinder/script/controller/FileEntryApiController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
import org.slf4j.LoggerFactory;
import org.springframework.context.MessageSource;
import org.springframework.http.ContentDisposition;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

Expand All @@ -65,6 +66,7 @@
@RestController
@RequestMapping("/script/api")
@RequiredArgsConstructor
@PreAuthorize("hasAnyRole('A', 'S', 'U')")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of FileEntiry related APIs need authorization even if the method doesn't have a User parameter.

public class FileEntryApiController {

private static final Logger LOG = LoggerFactory.getLogger(FileEntryApiController.class);
Expand Down
2 changes: 1 addition & 1 deletion ngrinder-frontend/src/js/components/perftest/list/List.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
}

this.tests[target.index].status = updatedStatus;
this.runningSummary = `${res.data.perfTestInfo.length} ${this.i18n('perfTest.list.runningSummary')}`;
this.runningSummary = `${res.data.runningTestsCount} ${this.i18n('perfTest.list.runningSummary')}`;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It unnecessarily exposed other users' performance test information. So, changed it.

});
}).finally(() => this.updateStatusTimeoutId = setTimeout(this.updatePerftestStatus, 2000));
} else {
Expand Down
Loading