| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469 |
- package pluginproxy
- import (
- "bytes"
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "io/ioutil"
- "net"
- "net/http"
- "net/http/httputil"
- "net/url"
- "strconv"
- "strings"
- "text/template"
- "time"
- "github.com/opentracing/opentracing-go"
- "golang.org/x/oauth2/jwt"
- "github.com/grafana/grafana/pkg/log"
- m "github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/plugins"
- "github.com/grafana/grafana/pkg/setting"
- "github.com/grafana/grafana/pkg/util"
- )
- var (
- logger = log.New("data-proxy-log")
- tokenCache = map[string]*jwtToken{}
- client = newHTTPClient()
- )
- type jwtToken struct {
- ExpiresOn time.Time `json:"-"`
- ExpiresOnString string `json:"expires_on"`
- AccessToken string `json:"access_token"`
- }
- type DataSourceProxy struct {
- ds *m.DataSource
- ctx *m.ReqContext
- targetUrl *url.URL
- proxyPath string
- route *plugins.AppPluginRoute
- plugin *plugins.DataSourcePlugin
- }
- type httpClient interface {
- Do(req *http.Request) (*http.Response, error)
- }
- func NewDataSourceProxy(ds *m.DataSource, plugin *plugins.DataSourcePlugin, ctx *m.ReqContext, proxyPath string) *DataSourceProxy {
- targetURL, _ := url.Parse(ds.Url)
- return &DataSourceProxy{
- ds: ds,
- plugin: plugin,
- ctx: ctx,
- proxyPath: proxyPath,
- targetUrl: targetURL,
- }
- }
- func newHTTPClient() httpClient {
- return &http.Client{
- Timeout: time.Second * 30,
- Transport: &http.Transport{Proxy: http.ProxyFromEnvironment},
- }
- }
- func (proxy *DataSourceProxy) HandleRequest() {
- if err := proxy.validateRequest(); err != nil {
- proxy.ctx.JsonApiErr(403, err.Error(), nil)
- return
- }
- reverseProxy := &httputil.ReverseProxy{
- Director: proxy.getDirector(),
- FlushInterval: time.Millisecond * 200,
- }
- var err error
- reverseProxy.Transport, err = proxy.ds.GetHttpTransport()
- if err != nil {
- proxy.ctx.JsonApiErr(400, "Unable to load TLS certificate", err)
- return
- }
- proxy.logRequest()
- span, ctx := opentracing.StartSpanFromContext(proxy.ctx.Req.Context(), "datasource reverse proxy")
- proxy.ctx.Req.Request = proxy.ctx.Req.WithContext(ctx)
- defer span.Finish()
- span.SetTag("datasource_id", proxy.ds.Id)
- span.SetTag("datasource_type", proxy.ds.Type)
- span.SetTag("user_id", proxy.ctx.SignedInUser.UserId)
- span.SetTag("org_id", proxy.ctx.SignedInUser.OrgId)
- proxy.addTraceFromHeaderValue(span, "X-Panel-Id", "panel_id")
- proxy.addTraceFromHeaderValue(span, "X-Dashboard-Id", "dashboard_id")
- opentracing.GlobalTracer().Inject(
- span.Context(),
- opentracing.HTTPHeaders,
- opentracing.HTTPHeadersCarrier(proxy.ctx.Req.Request.Header))
- reverseProxy.ServeHTTP(proxy.ctx.Resp, proxy.ctx.Req.Request)
- proxy.ctx.Resp.Header().Del("Set-Cookie")
- }
- func (proxy *DataSourceProxy) addTraceFromHeaderValue(span opentracing.Span, headerName string, tagName string) {
- panelId := proxy.ctx.Req.Header.Get(headerName)
- dashId, err := strconv.Atoi(panelId)
- if err == nil {
- span.SetTag(tagName, dashId)
- }
- }
- func (proxy *DataSourceProxy) useCustomHeaders(req *http.Request) {
- decryptSdj := proxy.ds.SecureJsonData.Decrypt()
- index := 1
- for {
- headerNameSuffix := fmt.Sprintf("httpHeaderName%d", index)
- headerValueSuffix := fmt.Sprintf("httpHeaderValue%d", index)
- if key := proxy.ds.JsonData.Get(headerNameSuffix).MustString(); key != "" {
- if val, ok := decryptSdj[headerValueSuffix]; ok {
- // remove if exists
- if req.Header.Get(key) != "" {
- req.Header.Del(key)
- }
- req.Header.Add(key, val)
- logger.Debug("Using custom header ", "CustomHeaders", key)
- }
- } else {
- break
- }
- index += 1
- }
- }
- func (proxy *DataSourceProxy) getDirector() func(req *http.Request) {
- return func(req *http.Request) {
- req.URL.Scheme = proxy.targetUrl.Scheme
- req.URL.Host = proxy.targetUrl.Host
- req.Host = proxy.targetUrl.Host
- reqQueryVals := req.URL.Query()
- if proxy.ds.Type == m.DS_INFLUXDB_08 {
- req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, "db/"+proxy.ds.Database+"/"+proxy.proxyPath)
- reqQueryVals.Add("u", proxy.ds.User)
- reqQueryVals.Add("p", proxy.ds.Password)
- req.URL.RawQuery = reqQueryVals.Encode()
- } else if proxy.ds.Type == m.DS_INFLUXDB {
- req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, proxy.proxyPath)
- req.URL.RawQuery = reqQueryVals.Encode()
- if !proxy.ds.BasicAuth {
- req.Header.Del("Authorization")
- req.Header.Add("Authorization", util.GetBasicAuthHeader(proxy.ds.User, proxy.ds.Password))
- }
- } else {
- req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, proxy.proxyPath)
- }
- if proxy.ds.BasicAuth {
- req.Header.Del("Authorization")
- req.Header.Add("Authorization", util.GetBasicAuthHeader(proxy.ds.BasicAuthUser, proxy.ds.BasicAuthPassword))
- }
- // Lookup and use custom headers
- if proxy.ds.SecureJsonData != nil {
- proxy.useCustomHeaders(req)
- }
- dsAuth := req.Header.Get("X-DS-Authorization")
- if len(dsAuth) > 0 {
- req.Header.Del("X-DS-Authorization")
- req.Header.Del("Authorization")
- req.Header.Add("Authorization", dsAuth)
- }
- // clear cookie header, except for whitelisted cookies
- var keptCookies []*http.Cookie
- if proxy.ds.JsonData != nil {
- if keepCookies := proxy.ds.JsonData.Get("keepCookies"); keepCookies != nil {
- keepCookieNames := keepCookies.MustStringArray()
- for _, c := range req.Cookies() {
- for _, v := range keepCookieNames {
- if c.Name == v {
- keptCookies = append(keptCookies, c)
- }
- }
- }
- }
- }
- req.Header.Del("Cookie")
- for _, c := range keptCookies {
- req.AddCookie(c)
- }
- // clear X-Forwarded Host/Port/Proto headers
- req.Header.Del("X-Forwarded-Host")
- req.Header.Del("X-Forwarded-Port")
- req.Header.Del("X-Forwarded-Proto")
- req.Header.Set("User-Agent", fmt.Sprintf("Grafana/%s", setting.BuildVersion))
- // set X-Forwarded-For header
- if req.RemoteAddr != "" {
- remoteAddr, _, err := net.SplitHostPort(req.RemoteAddr)
- if err != nil {
- remoteAddr = req.RemoteAddr
- }
- if req.Header.Get("X-Forwarded-For") != "" {
- req.Header.Set("X-Forwarded-For", req.Header.Get("X-Forwarded-For")+", "+remoteAddr)
- } else {
- req.Header.Set("X-Forwarded-For", remoteAddr)
- }
- }
- if proxy.route != nil {
- proxy.applyRoute(req)
- }
- }
- }
- func (proxy *DataSourceProxy) validateRequest() error {
- if !checkWhiteList(proxy.ctx, proxy.targetUrl.Host) {
- return errors.New("Target url is not a valid target")
- }
- if proxy.ds.Type == m.DS_PROMETHEUS {
- if proxy.ctx.Req.Request.Method == "DELETE" {
- return errors.New("Deletes not allowed on proxied Prometheus datasource")
- }
- if proxy.ctx.Req.Request.Method == "PUT" {
- return errors.New("Puts not allowed on proxied Prometheus datasource")
- }
- if proxy.ctx.Req.Request.Method == "POST" && !(proxy.proxyPath == "api/v1/query" || proxy.proxyPath == "api/v1/query_range") {
- return errors.New("Posts not allowed on proxied Prometheus datasource except on /query and /query_range")
- }
- }
- if proxy.ds.Type == m.DS_ES {
- if proxy.ctx.Req.Request.Method == "DELETE" {
- return errors.New("Deletes not allowed on proxied Elasticsearch datasource")
- }
- if proxy.ctx.Req.Request.Method == "PUT" {
- return errors.New("Puts not allowed on proxied Elasticsearch datasource")
- }
- if proxy.ctx.Req.Request.Method == "POST" && proxy.proxyPath != "_msearch" {
- return errors.New("Posts not allowed on proxied Elasticsearch datasource except on /_msearch")
- }
- }
- // found route if there are any
- if len(proxy.plugin.Routes) > 0 {
- for _, route := range proxy.plugin.Routes {
- // method match
- if route.Method != "" && route.Method != "*" && route.Method != proxy.ctx.Req.Method {
- continue
- }
- if route.ReqRole.IsValid() {
- if !proxy.ctx.HasUserRole(route.ReqRole) {
- return errors.New("Plugin proxy route access denied")
- }
- }
- if strings.HasPrefix(proxy.proxyPath, route.Path) {
- proxy.route = route
- break
- }
- }
- }
- return nil
- }
- func (proxy *DataSourceProxy) logRequest() {
- if !setting.DataProxyLogging {
- return
- }
- var body string
- if proxy.ctx.Req.Request.Body != nil {
- buffer, err := ioutil.ReadAll(proxy.ctx.Req.Request.Body)
- if err == nil {
- proxy.ctx.Req.Request.Body = ioutil.NopCloser(bytes.NewBuffer(buffer))
- body = string(buffer)
- }
- }
- logger.Info("Proxying incoming request",
- "userid", proxy.ctx.UserId,
- "orgid", proxy.ctx.OrgId,
- "username", proxy.ctx.Login,
- "datasource", proxy.ds.Type,
- "uri", proxy.ctx.Req.RequestURI,
- "method", proxy.ctx.Req.Request.Method,
- "body", body)
- }
- func checkWhiteList(c *m.ReqContext, host string) bool {
- if host != "" && len(setting.DataProxyWhiteList) > 0 {
- if _, exists := setting.DataProxyWhiteList[host]; !exists {
- c.JsonApiErr(403, "Data proxy hostname and ip are not included in whitelist", nil)
- return false
- }
- }
- return true
- }
- func (proxy *DataSourceProxy) applyRoute(req *http.Request) {
- proxy.proxyPath = strings.TrimPrefix(proxy.proxyPath, proxy.route.Path)
- data := templateData{
- JsonData: proxy.ds.JsonData.Interface().(map[string]interface{}),
- SecureJsonData: proxy.ds.SecureJsonData.Decrypt(),
- }
- interpolatedURL, err := interpolateString(proxy.route.Url, data)
- if err != nil {
- logger.Error("Error interpolating proxy url", "error", err)
- return
- }
- routeURL, err := url.Parse(interpolatedURL)
- if err != nil {
- logger.Error("Error parsing plugin route url", "error", err)
- return
- }
- req.URL.Scheme = routeURL.Scheme
- req.URL.Host = routeURL.Host
- req.Host = routeURL.Host
- req.URL.Path = util.JoinUrlFragments(routeURL.Path, proxy.proxyPath)
- if err := addHeaders(&req.Header, proxy.route, data); err != nil {
- logger.Error("Failed to render plugin headers", "error", err)
- }
- if proxy.route.TokenAuth != nil {
- if token, err := proxy.getAccessToken(data); err != nil {
- logger.Error("Failed to get access token", "error", err)
- } else {
- req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token))
- }
- }
- if proxy.route.JwtTokenAuth != nil {
- if token, err := proxy.getJwtAccessToken(data); err != nil {
- logger.Error("Failed to get access token", "error", err)
- } else {
- req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token))
- }
- }
- logger.Info("Requesting", "url", req.URL.String())
- }
- func (proxy *DataSourceProxy) getAccessToken(data templateData) (string, error) {
- if cachedToken, found := tokenCache[proxy.getAccessTokenCacheKey()]; found {
- if cachedToken.ExpiresOn.After(time.Now().Add(time.Second * 10)) {
- logger.Info("Using token from cache")
- return cachedToken.AccessToken, nil
- }
- }
- urlInterpolated, err := interpolateString(proxy.route.TokenAuth.Url, data)
- if err != nil {
- return "", err
- }
- params := make(url.Values)
- for key, value := range proxy.route.TokenAuth.Params {
- interpolatedParam, err := interpolateString(value, data)
- if err != nil {
- return "", err
- }
- params.Add(key, interpolatedParam)
- }
- getTokenReq, _ := http.NewRequest("POST", urlInterpolated, bytes.NewBufferString(params.Encode()))
- getTokenReq.Header.Add("Content-Type", "application/x-www-form-urlencoded")
- getTokenReq.Header.Add("Content-Length", strconv.Itoa(len(params.Encode())))
- resp, err := client.Do(getTokenReq)
- if err != nil {
- return "", err
- }
- defer resp.Body.Close()
- var token jwtToken
- if err := json.NewDecoder(resp.Body).Decode(&token); err != nil {
- return "", err
- }
- expiresOnEpoch, _ := strconv.ParseInt(token.ExpiresOnString, 10, 64)
- token.ExpiresOn = time.Unix(expiresOnEpoch, 0)
- tokenCache[proxy.getAccessTokenCacheKey()] = &token
- logger.Info("Got new access token", "ExpiresOn", token.ExpiresOn)
- return token.AccessToken, nil
- }
- func (proxy *DataSourceProxy) getJwtAccessToken(data templateData) (string, error) {
- conf := new(jwt.Config)
- if val, ok := proxy.route.JwtTokenAuth.Params["client_email"]; ok {
- interpolatedVal, err := interpolateString(val, data)
- if err != nil {
- return "", err
- }
- conf.Email = interpolatedVal
- }
- if val, ok := proxy.route.JwtTokenAuth.Params["private_key"]; ok {
- interpolatedVal, err := interpolateString(val, data)
- if err != nil {
- return "", err
- }
- conf.PrivateKey = []byte(interpolatedVal)
- }
- conf.Scopes = []string{"https://www.googleapis.com/auth/monitoring.read"}
- conf.TokenURL = "https://oauth2.googleapis.com/token"
- ctx := context.Background()
- tokenSrc := conf.TokenSource(ctx)
- token, err := tokenSrc.Token()
- if err != nil {
- return "", err
- }
- return token.AccessToken, nil
- }
- func (proxy *DataSourceProxy) getAccessTokenCacheKey() string {
- return fmt.Sprintf("%v_%v_%v", proxy.ds.Id, proxy.route.Path, proxy.route.Method)
- }
- func interpolateString(text string, data templateData) (string, error) {
- t, err := template.New("content").Parse(text)
- if err != nil {
- return "", fmt.Errorf("could not parse template %s", text)
- }
- var contentBuf bytes.Buffer
- err = t.Execute(&contentBuf, data)
- if err != nil {
- return "", fmt.Errorf("failed to execute template %s", text)
- }
- return contentBuf.String(), nil
- }
- func addHeaders(reqHeaders *http.Header, route *plugins.AppPluginRoute, data templateData) error {
- for _, header := range route.Headers {
- interpolated, err := interpolateString(header.Content, data)
- if err != nil {
- return err
- }
- reqHeaders.Add(header.Name, interpolated)
- }
- return nil
- }
|