ds_proxy.go 11 KB

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