ds_proxy.go 9.9 KB

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