ds_proxy.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. package pluginproxy
  2. import (
  3. "bytes"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "io/ioutil"
  8. "net"
  9. "net/http"
  10. "net/http/httputil"
  11. "net/url"
  12. "strconv"
  13. "strings"
  14. "text/template"
  15. "time"
  16. "github.com/opentracing/opentracing-go"
  17. "github.com/grafana/grafana/pkg/log"
  18. m "github.com/grafana/grafana/pkg/models"
  19. "github.com/grafana/grafana/pkg/plugins"
  20. "github.com/grafana/grafana/pkg/setting"
  21. "github.com/grafana/grafana/pkg/util"
  22. )
  23. var (
  24. logger = log.New("data-proxy-log")
  25. client = &http.Client{
  26. Timeout: time.Second * 30,
  27. Transport: &http.Transport{Proxy: http.ProxyFromEnvironment},
  28. }
  29. tokenCache = map[int64]*jwtToken{}
  30. )
  31. type jwtToken struct {
  32. ExpiresOn time.Time `json:"-"`
  33. ExpiresOnString string `json:"expires_on"`
  34. AccessToken string `json:"access_token"`
  35. }
  36. type DataSourceProxy struct {
  37. ds *m.DataSource
  38. ctx *m.ReqContext
  39. targetUrl *url.URL
  40. proxyPath string
  41. route *plugins.AppPluginRoute
  42. plugin *plugins.DataSourcePlugin
  43. }
  44. func NewDataSourceProxy(ds *m.DataSource, plugin *plugins.DataSourcePlugin, ctx *m.ReqContext, proxyPath string) *DataSourceProxy {
  45. targetURL, _ := url.Parse(ds.Url)
  46. return &DataSourceProxy{
  47. ds: ds,
  48. plugin: plugin,
  49. ctx: ctx,
  50. proxyPath: proxyPath,
  51. targetUrl: targetURL,
  52. }
  53. }
  54. func (proxy *DataSourceProxy) HandleRequest() {
  55. if err := proxy.validateRequest(); err != nil {
  56. proxy.ctx.JsonApiErr(403, err.Error(), nil)
  57. return
  58. }
  59. reverseProxy := &httputil.ReverseProxy{
  60. Director: proxy.getDirector(),
  61. FlushInterval: time.Millisecond * 200,
  62. }
  63. var err error
  64. reverseProxy.Transport, err = proxy.ds.GetHttpTransport()
  65. if err != nil {
  66. proxy.ctx.JsonApiErr(400, "Unable to load TLS certificate", err)
  67. return
  68. }
  69. proxy.logRequest()
  70. span, ctx := opentracing.StartSpanFromContext(proxy.ctx.Req.Context(), "datasource reverse proxy")
  71. proxy.ctx.Req.Request = proxy.ctx.Req.WithContext(ctx)
  72. defer span.Finish()
  73. span.SetTag("datasource_id", proxy.ds.Id)
  74. span.SetTag("datasource_type", proxy.ds.Type)
  75. span.SetTag("user_id", proxy.ctx.SignedInUser.UserId)
  76. span.SetTag("org_id", proxy.ctx.SignedInUser.OrgId)
  77. proxy.addTraceFromHeaderValue(span, "X-Panel-Id", "panel_id")
  78. proxy.addTraceFromHeaderValue(span, "X-Dashboard-Id", "dashboard_id")
  79. opentracing.GlobalTracer().Inject(
  80. span.Context(),
  81. opentracing.HTTPHeaders,
  82. opentracing.HTTPHeadersCarrier(proxy.ctx.Req.Request.Header))
  83. reverseProxy.ServeHTTP(proxy.ctx.Resp, proxy.ctx.Req.Request)
  84. proxy.ctx.Resp.Header().Del("Set-Cookie")
  85. }
  86. func (proxy *DataSourceProxy) addTraceFromHeaderValue(span opentracing.Span, headerName string, tagName string) {
  87. panelId := proxy.ctx.Req.Header.Get(headerName)
  88. dashId, err := strconv.Atoi(panelId)
  89. if err == nil {
  90. span.SetTag(tagName, dashId)
  91. }
  92. }
  93. func (proxy *DataSourceProxy) getDirector() func(req *http.Request) {
  94. return func(req *http.Request) {
  95. req.URL.Scheme = proxy.targetUrl.Scheme
  96. req.URL.Host = proxy.targetUrl.Host
  97. req.Host = proxy.targetUrl.Host
  98. reqQueryVals := req.URL.Query()
  99. if proxy.ds.Type == m.DS_INFLUXDB_08 {
  100. req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, "db/"+proxy.ds.Database+"/"+proxy.proxyPath)
  101. reqQueryVals.Add("u", proxy.ds.User)
  102. reqQueryVals.Add("p", proxy.ds.Password)
  103. req.URL.RawQuery = reqQueryVals.Encode()
  104. } else if proxy.ds.Type == m.DS_INFLUXDB {
  105. req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, proxy.proxyPath)
  106. req.URL.RawQuery = reqQueryVals.Encode()
  107. if !proxy.ds.BasicAuth {
  108. req.Header.Del("Authorization")
  109. req.Header.Add("Authorization", util.GetBasicAuthHeader(proxy.ds.User, proxy.ds.Password))
  110. }
  111. } else {
  112. req.URL.Path = util.JoinUrlFragments(proxy.targetUrl.Path, proxy.proxyPath)
  113. }
  114. if proxy.ds.BasicAuth {
  115. req.Header.Del("Authorization")
  116. req.Header.Add("Authorization", util.GetBasicAuthHeader(proxy.ds.BasicAuthUser, proxy.ds.BasicAuthPassword))
  117. }
  118. dsAuth := req.Header.Get("X-DS-Authorization")
  119. if len(dsAuth) > 0 {
  120. req.Header.Del("X-DS-Authorization")
  121. req.Header.Del("Authorization")
  122. req.Header.Add("Authorization", dsAuth)
  123. }
  124. // clear cookie header, except for whitelisted cookies
  125. var keptCookies []*http.Cookie
  126. if proxy.ds.JsonData != nil {
  127. if keepCookies := proxy.ds.JsonData.Get("keepCookies"); keepCookies != nil {
  128. keepCookieNames := keepCookies.MustStringArray()
  129. for _, c := range req.Cookies() {
  130. for _, v := range keepCookieNames {
  131. if c.Name == v {
  132. keptCookies = append(keptCookies, c)
  133. }
  134. }
  135. }
  136. }
  137. }
  138. req.Header.Del("Cookie")
  139. for _, c := range keptCookies {
  140. req.AddCookie(c)
  141. }
  142. // clear X-Forwarded Host/Port/Proto headers
  143. req.Header.Del("X-Forwarded-Host")
  144. req.Header.Del("X-Forwarded-Port")
  145. req.Header.Del("X-Forwarded-Proto")
  146. // set X-Forwarded-For header
  147. if req.RemoteAddr != "" {
  148. remoteAddr, _, err := net.SplitHostPort(req.RemoteAddr)
  149. if err != nil {
  150. remoteAddr = req.RemoteAddr
  151. }
  152. if req.Header.Get("X-Forwarded-For") != "" {
  153. req.Header.Set("X-Forwarded-For", req.Header.Get("X-Forwarded-For")+", "+remoteAddr)
  154. } else {
  155. req.Header.Set("X-Forwarded-For", remoteAddr)
  156. }
  157. }
  158. if proxy.route != nil {
  159. proxy.applyRoute(req)
  160. }
  161. }
  162. }
  163. func (proxy *DataSourceProxy) validateRequest() error {
  164. if !checkWhiteList(proxy.ctx, proxy.targetUrl.Host) {
  165. return errors.New("Target url is not a valid target")
  166. }
  167. if proxy.ds.Type == m.DS_PROMETHEUS {
  168. if proxy.ctx.Req.Request.Method == "DELETE" {
  169. return errors.New("Deletes not allowed on proxied Prometheus datasource")
  170. }
  171. if proxy.ctx.Req.Request.Method == "PUT" {
  172. return errors.New("Puts not allowed on proxied Prometheus datasource")
  173. }
  174. if proxy.ctx.Req.Request.Method == "POST" && !(proxy.proxyPath == "api/v1/query" || proxy.proxyPath == "api/v1/query_range") {
  175. return errors.New("Posts not allowed on proxied Prometheus datasource except on /query and /query_range")
  176. }
  177. }
  178. if proxy.ds.Type == m.DS_ES {
  179. if proxy.ctx.Req.Request.Method == "DELETE" {
  180. return errors.New("Deletes not allowed on proxied Elasticsearch datasource")
  181. }
  182. if proxy.ctx.Req.Request.Method == "PUT" {
  183. return errors.New("Puts not allowed on proxied Elasticsearch datasource")
  184. }
  185. if proxy.ctx.Req.Request.Method == "POST" && proxy.proxyPath != "_msearch" {
  186. return errors.New("Posts not allowed on proxied Elasticsearch datasource except on /_msearch")
  187. }
  188. }
  189. // found route if there are any
  190. if len(proxy.plugin.Routes) > 0 {
  191. for _, route := range proxy.plugin.Routes {
  192. // method match
  193. if route.Method != "" && route.Method != "*" && route.Method != proxy.ctx.Req.Method {
  194. continue
  195. }
  196. if route.ReqRole.IsValid() {
  197. if !proxy.ctx.HasUserRole(route.ReqRole) {
  198. return errors.New("Plugin proxy route access denied")
  199. }
  200. }
  201. if strings.HasPrefix(proxy.proxyPath, route.Path) {
  202. proxy.route = route
  203. break
  204. }
  205. }
  206. }
  207. return nil
  208. }
  209. func (proxy *DataSourceProxy) logRequest() {
  210. if !setting.DataProxyLogging {
  211. return
  212. }
  213. var body string
  214. if proxy.ctx.Req.Request.Body != nil {
  215. buffer, err := ioutil.ReadAll(proxy.ctx.Req.Request.Body)
  216. if err == nil {
  217. proxy.ctx.Req.Request.Body = ioutil.NopCloser(bytes.NewBuffer(buffer))
  218. body = string(buffer)
  219. }
  220. }
  221. logger.Info("Proxying incoming request",
  222. "userid", proxy.ctx.UserId,
  223. "orgid", proxy.ctx.OrgId,
  224. "username", proxy.ctx.Login,
  225. "datasource", proxy.ds.Type,
  226. "uri", proxy.ctx.Req.RequestURI,
  227. "method", proxy.ctx.Req.Request.Method,
  228. "body", body)
  229. }
  230. func checkWhiteList(c *m.ReqContext, host string) bool {
  231. if host != "" && len(setting.DataProxyWhiteList) > 0 {
  232. if _, exists := setting.DataProxyWhiteList[host]; !exists {
  233. c.JsonApiErr(403, "Data proxy hostname and ip are not included in whitelist", nil)
  234. return false
  235. }
  236. }
  237. return true
  238. }
  239. func (proxy *DataSourceProxy) applyRoute(req *http.Request) {
  240. proxy.proxyPath = strings.TrimPrefix(proxy.proxyPath, proxy.route.Path)
  241. data := templateData{
  242. JsonData: proxy.ds.JsonData.Interface().(map[string]interface{}),
  243. SecureJsonData: proxy.ds.SecureJsonData.Decrypt(),
  244. }
  245. routeURL, err := url.Parse(proxy.route.Url)
  246. if err != nil {
  247. logger.Error("Error parsing plugin route url")
  248. return
  249. }
  250. req.URL.Scheme = routeURL.Scheme
  251. req.URL.Host = routeURL.Host
  252. req.Host = routeURL.Host
  253. req.URL.Path = util.JoinUrlFragments(routeURL.Path, proxy.proxyPath)
  254. if err := addHeaders(&req.Header, proxy.route, data); err != nil {
  255. logger.Error("Failed to render plugin headers", "error", err)
  256. }
  257. if proxy.route.TokenAuth != nil {
  258. if token, err := proxy.getAccessToken(data); err != nil {
  259. logger.Error("Failed to get access token", "error", err)
  260. } else {
  261. req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token))
  262. }
  263. }
  264. logger.Info("Requesting", "url", req.URL.String())
  265. }
  266. func (proxy *DataSourceProxy) getAccessToken(data templateData) (string, error) {
  267. if cachedToken, found := tokenCache[proxy.ds.Id]; found {
  268. if cachedToken.ExpiresOn.After(time.Now().Add(time.Second * 10)) {
  269. logger.Info("Using token from cache")
  270. return cachedToken.AccessToken, nil
  271. }
  272. }
  273. urlInterpolated, err := interpolateString(proxy.route.TokenAuth.Url, data)
  274. if err != nil {
  275. return "", err
  276. }
  277. params := make(url.Values)
  278. for key, value := range proxy.route.TokenAuth.Params {
  279. interpolatedParam, err := interpolateString(value, data)
  280. if err != nil {
  281. return "", err
  282. }
  283. params.Add(key, interpolatedParam)
  284. }
  285. getTokenReq, _ := http.NewRequest("POST", urlInterpolated, bytes.NewBufferString(params.Encode()))
  286. getTokenReq.Header.Add("Content-Type", "application/x-www-form-urlencoded")
  287. getTokenReq.Header.Add("Content-Length", strconv.Itoa(len(params.Encode())))
  288. resp, err := client.Do(getTokenReq)
  289. if err != nil {
  290. return "", err
  291. }
  292. defer resp.Body.Close()
  293. var token jwtToken
  294. if err := json.NewDecoder(resp.Body).Decode(&token); err != nil {
  295. return "", err
  296. }
  297. expiresOnEpoch, _ := strconv.ParseInt(token.ExpiresOnString, 10, 64)
  298. token.ExpiresOn = time.Unix(expiresOnEpoch, 0)
  299. tokenCache[proxy.ds.Id] = &token
  300. logger.Info("Got new access token", "ExpiresOn", token.ExpiresOn)
  301. return token.AccessToken, nil
  302. }
  303. func interpolateString(text string, data templateData) (string, error) {
  304. t, err := template.New("content").Parse(text)
  305. if err != nil {
  306. return "", fmt.Errorf("could not parse template %s", text)
  307. }
  308. var contentBuf bytes.Buffer
  309. err = t.Execute(&contentBuf, data)
  310. if err != nil {
  311. return "", fmt.Errorf("failed to execute template %s", text)
  312. }
  313. return contentBuf.String(), nil
  314. }
  315. func addHeaders(reqHeaders *http.Header, route *plugins.AppPluginRoute, data templateData) error {
  316. for _, header := range route.Headers {
  317. interpolated, err := interpolateString(header.Content, data)
  318. if err != nil {
  319. return err
  320. }
  321. reqHeaders.Add(header.Name, interpolated)
  322. }
  323. return nil
  324. }