ds_proxy.go 11 KB

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