Datasources: Fix Proxy by UID Failing for UIDs with a Hyphen (#61723)
Fix Proxy by UID Failing for UIDs with a Hyphen
Hyphens are allowed in short IDs but not picked up by the
proxyPathRegexp. This caused the end of the uid to be proxied as part of
the path to the backing datasource which would usually cause a 404.
(cherry picked from commit f85d072c17)
Co-authored-by: Chris Marchbanks <csmarchbanks@gmail.com>
143 lines
4.7 KiB
Go
143 lines
4.7 KiB
Go
package datasourceproxy
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"regexp"
|
|
"strconv"
|
|
|
|
"github.com/grafana/grafana/pkg/api/datasource"
|
|
"github.com/grafana/grafana/pkg/api/pluginproxy"
|
|
"github.com/grafana/grafana/pkg/infra/httpclient"
|
|
"github.com/grafana/grafana/pkg/infra/metrics"
|
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/plugins"
|
|
"github.com/grafana/grafana/pkg/services/datasources"
|
|
"github.com/grafana/grafana/pkg/services/oauthtoken"
|
|
"github.com/grafana/grafana/pkg/services/secrets"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/grafana/grafana/pkg/util"
|
|
"github.com/grafana/grafana/pkg/web"
|
|
)
|
|
|
|
func ProvideService(dataSourceCache datasources.CacheService, plugReqValidator models.PluginRequestValidator,
|
|
pluginStore plugins.Store, cfg *setting.Cfg, httpClientProvider httpclient.Provider,
|
|
oauthTokenService *oauthtoken.Service, dsService datasources.DataSourceService,
|
|
tracer tracing.Tracer, secretsService secrets.Service) *DataSourceProxyService {
|
|
return &DataSourceProxyService{
|
|
DataSourceCache: dataSourceCache,
|
|
PluginRequestValidator: plugReqValidator,
|
|
pluginStore: pluginStore,
|
|
Cfg: cfg,
|
|
HTTPClientProvider: httpClientProvider,
|
|
OAuthTokenService: oauthTokenService,
|
|
DataSourcesService: dsService,
|
|
tracer: tracer,
|
|
secretsService: secretsService,
|
|
}
|
|
}
|
|
|
|
type DataSourceProxyService struct {
|
|
DataSourceCache datasources.CacheService
|
|
PluginRequestValidator models.PluginRequestValidator
|
|
pluginStore plugins.Store
|
|
Cfg *setting.Cfg
|
|
HTTPClientProvider httpclient.Provider
|
|
OAuthTokenService *oauthtoken.Service
|
|
DataSourcesService datasources.DataSourceService
|
|
tracer tracing.Tracer
|
|
secretsService secrets.Service
|
|
}
|
|
|
|
func (p *DataSourceProxyService) ProxyDataSourceRequest(c *models.ReqContext) {
|
|
id, err := strconv.ParseInt(web.Params(c.Req)[":id"], 10, 64)
|
|
if err != nil {
|
|
c.JsonApiErr(http.StatusBadRequest, "id is invalid", err)
|
|
return
|
|
}
|
|
p.ProxyDatasourceRequestWithID(c, id)
|
|
}
|
|
|
|
func (p *DataSourceProxyService) ProxyDatasourceRequestWithUID(c *models.ReqContext, dsUID string) {
|
|
c.TimeRequest(metrics.MDataSourceProxyReqTimer)
|
|
|
|
if dsUID == "" { // if datasource UID is not provided, fetch it from the uid path parameter
|
|
dsUID = web.Params(c.Req)[":uid"]
|
|
}
|
|
|
|
if !util.IsValidShortUID(dsUID) {
|
|
c.JsonApiErr(http.StatusBadRequest, "UID is invalid", nil)
|
|
return
|
|
}
|
|
|
|
ds, err := p.DataSourceCache.GetDatasourceByUID(c.Req.Context(), dsUID, c.SignedInUser, c.SkipCache)
|
|
if err != nil {
|
|
toAPIError(c, err)
|
|
return
|
|
}
|
|
p.proxyDatasourceRequest(c, ds)
|
|
}
|
|
|
|
func (p *DataSourceProxyService) ProxyDatasourceRequestWithID(c *models.ReqContext, dsID int64) {
|
|
c.TimeRequest(metrics.MDataSourceProxyReqTimer)
|
|
|
|
ds, err := p.DataSourceCache.GetDatasource(c.Req.Context(), dsID, c.SignedInUser, c.SkipCache)
|
|
if err != nil {
|
|
toAPIError(c, err)
|
|
return
|
|
}
|
|
p.proxyDatasourceRequest(c, ds)
|
|
}
|
|
|
|
func toAPIError(c *models.ReqContext, err error) {
|
|
if errors.Is(err, datasources.ErrDataSourceAccessDenied) {
|
|
c.JsonApiErr(http.StatusForbidden, "Access denied to datasource", err)
|
|
return
|
|
}
|
|
if errors.Is(err, datasources.ErrDataSourceNotFound) {
|
|
c.JsonApiErr(http.StatusNotFound, "Unable to find datasource", err)
|
|
return
|
|
}
|
|
c.JsonApiErr(http.StatusInternalServerError, "Unable to load datasource meta data", err)
|
|
}
|
|
|
|
func (p *DataSourceProxyService) proxyDatasourceRequest(c *models.ReqContext, ds *datasources.DataSource) {
|
|
err := p.PluginRequestValidator.Validate(ds.Url, c.Req)
|
|
if err != nil {
|
|
c.JsonApiErr(http.StatusForbidden, "Access denied", err)
|
|
return
|
|
}
|
|
|
|
// find plugin
|
|
plugin, exists := p.pluginStore.Plugin(c.Req.Context(), ds.Type)
|
|
if !exists {
|
|
c.JsonApiErr(http.StatusNotFound, "Unable to find datasource plugin", err)
|
|
return
|
|
}
|
|
|
|
proxyPath := getProxyPath(c)
|
|
proxy, err := pluginproxy.NewDataSourceProxy(ds, plugin.Routes, c, proxyPath, p.Cfg, p.HTTPClientProvider,
|
|
p.OAuthTokenService, p.DataSourcesService, p.tracer)
|
|
if err != nil {
|
|
if errors.Is(err, datasource.URLValidationError{}) {
|
|
c.JsonApiErr(http.StatusBadRequest, fmt.Sprintf("Invalid data source URL: %q", ds.Url), err)
|
|
} else {
|
|
c.JsonApiErr(http.StatusInternalServerError, "Failed creating data source proxy", err)
|
|
}
|
|
return
|
|
}
|
|
proxy.HandleRequest()
|
|
}
|
|
|
|
var proxyPathRegexp = regexp.MustCompile(`^\/api\/datasources\/proxy\/([\d]+|uid\/[\w-]+)\/?`)
|
|
|
|
func extractProxyPath(originalRawPath string) string {
|
|
return proxyPathRegexp.ReplaceAllString(originalRawPath, "")
|
|
}
|
|
|
|
func getProxyPath(c *models.ReqContext) string {
|
|
return extractProxyPath(c.Req.URL.EscapedPath())
|
|
}
|