opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 21:32:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Improve API response for plugin assets (#36352)

Browse Source 
* improve API response for plugin assets 403

* remove unnecessary newline
This commit is contained in:
Will Browne
2021-07-07 03:18:05 -07:00
committed by GitHub
parent 069fb0cf38
commit 333d520528
2 changed files with 18 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/api/api.go
View File

@ -133,7 +133,7 @@ func (hs *HTTPServer) registerRoutes() {
r.Get("/api/login/ping", quota("session"), routing.Wrap(hs.LoginAPIPing)) r.Get("/api/login/ping", quota("session"), routing.Wrap(hs.LoginAPIPing))
// expose plugin file system assets // expose plugin file system assets
r.Get("/public/plugins/:pluginId/*", hs.GetPluginAssets) r.Get("/public/plugins/:pluginId/*", routing.Wrap(hs.GetPluginAssets))
// authed api // authed api
r.Group("/api", func(apiRoute routing.RouteRegister) { r.Group("/api", func(apiRoute routing.RouteRegister) {

38
pkg/api/plugins.go
View File

@ -3,14 +3,13 @@ package api
import ( import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt"
"net/http" "net/http"
"os" "os"
"path/filepath" "path/filepath"
"sort" "sort"
"strings" "strings"
"gopkg.in/macaron.v1"
"github.com/grafana/grafana-plugin-sdk-go/backend" "github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/api/response" "github.com/grafana/grafana/pkg/api/response"
@ -258,12 +257,11 @@ func (hs *HTTPServer) CollectPluginMetrics(c *models.ReqContext) response.Respon
// GetPluginAssets returns public plugin assets (images, JS, etc.) // GetPluginAssets returns public plugin assets (images, JS, etc.)
// //
// /public/plugins/:pluginId/* // /public/plugins/:pluginId/*
func (hs *HTTPServer) GetPluginAssets(c *models.ReqContext) { func (hs *HTTPServer) GetPluginAssets(c *models.ReqContext) response.Response {
pluginID := c.Params("pluginId") pluginID := c.Params("pluginId")
plugin := hs.PluginManager.GetPlugin(pluginID) plugin := hs.PluginManager.GetPlugin(pluginID)
if plugin == nil { if plugin == nil {
c.Handle(hs.Cfg, 404, "Plugin not found", nil) return response.Error(404, "Plugin not found", nil)
return
} }
requestedFile := filepath.Clean(c.Params("*")) requestedFile := filepath.Clean(c.Params("*"))
@ -275,11 +273,9 @@ func (hs *HTTPServer) GetPluginAssets(c *models.ReqContext) {
f, err := os.Open(pluginFilePath) f, err := os.Open(pluginFilePath)
if err != nil { if err != nil {
if os.IsNotExist(err) { if os.IsNotExist(err) {
c.Handle(hs.Cfg, 404, "Could not find plugin file", err) return response.Error(404, "Plugin file not found", err)
return
} }
c.Handle(hs.Cfg, 500, "Could not open plugin file", err) return response.Error(500, "Could not open plugin file", err)
return
} }
defer func() { defer func() {
if err := f.Close(); err != nil { if err := f.Close(); err != nil {
@ -289,28 +285,28 @@ func (hs *HTTPServer) GetPluginAssets(c *models.ReqContext) {
fi, err := f.Stat() fi, err := f.Stat()
if err != nil { if err != nil {
c.Handle(hs.Cfg, 500, "Plugin file exists but could not open", err) return response.Error(500, "Plugin file exists but could not open", err)
return
} }
if shouldExclude(fi) { if shouldExclude(fi) {
c.Handle(hs.Cfg, 404, "Plugin file not found", nil) return response.Error(403, "Plugin file access forbidden",
return fmt.Errorf("access is forbidden to executable plugin file %s", pluginFilePath))
} }
headers := func(c *macaron.Context) { resp := response.CreateNormalResponse(
c.Resp.Header().Set("Cache-Control", "public, max-age=3600") http.Header{"Content-Type": []string{"text/plain", "charset=utf-8"}},
} []byte{},
200)
if hs.Cfg.Env == setting.Dev { if hs.Cfg.Env == setting.Dev {
headers = func(c *macaron.Context) { resp.SetHeader("Cache-Control", "max-age=0, must-revalidate, no-cache")
c.Resp.Header().Set("Cache-Control", "max-age=0, must-revalidate, no-cache") } else {
} resp.SetHeader("Cache-Control", "public, max-age=3600")
} }
headers(c.Context) http.ServeContent(resp, c.Req.Request, pluginFilePath, fi.ModTime(), f)
http.ServeContent(c.Resp, c.Req.Request, pluginFilePath, fi.ModTime(), f) return resp
} }
// CheckHealth returns the health of a plugin. // CheckHealth returns the health of a plugin.