X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/4237a24fcc5e0ff8cf6429b04844ca5f8e5b48c5..4549a822999fb12b91a10f4da33d8d081913160a:/services/keep-web/handler_test.go diff --git a/services/keep-web/handler_test.go b/services/keep-web/handler_test.go index 29bcdac1b7..d368b4447f 100644 --- a/services/keep-web/handler_test.go +++ b/services/keep-web/handler_test.go @@ -2,12 +2,14 @@ // // SPDX-License-Identifier: AGPL-3.0 -package main +package keepweb import ( "bytes" + "context" "fmt" "html" + "io" "io/ioutil" "net/http" "net/http/httptest" @@ -16,50 +18,52 @@ import ( "path/filepath" "regexp" "strings" + "time" "git.arvados.org/arvados.git/lib/config" "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvadosclient" "git.arvados.org/arvados.git/sdk/go/arvadostest" "git.arvados.org/arvados.git/sdk/go/auth" "git.arvados.org/arvados.git/sdk/go/ctxlog" "git.arvados.org/arvados.git/sdk/go/keepclient" + "github.com/prometheus/client_golang/prometheus" + "github.com/sirupsen/logrus" check "gopkg.in/check.v1" ) var _ = check.Suite(&UnitSuite{}) +func init() { + arvados.DebugLocksPanicMode = true +} + type UnitSuite struct { - Config *arvados.Config + cluster *arvados.Cluster + handler *handler } func (s *UnitSuite) SetUpTest(c *check.C) { - ldr := config.NewLoader(bytes.NewBufferString("Clusters: {zzzzz: {}}"), ctxlog.TestLogger(c)) + logger := ctxlog.TestLogger(c) + ldr := config.NewLoader(bytes.NewBufferString("Clusters: {zzzzz: {}}"), logger) ldr.Path = "-" cfg, err := ldr.Load() c.Assert(err, check.IsNil) - s.Config = cfg -} - -func (s *UnitSuite) TestKeepClientBlockCache(c *check.C) { - cfg := newConfig(s.Config) - cfg.cluster.Collections.WebDAVCache.MaxBlockEntries = 42 - h := handler{Config: cfg} - c.Check(keepclient.DefaultBlockCache.MaxBlocks, check.Not(check.Equals), cfg.cluster.Collections.WebDAVCache.MaxBlockEntries) - u := mustParseURL("http://keep-web.example/c=" + arvadostest.FooCollection + "/t=" + arvadostest.ActiveToken + "/foo") - req := &http.Request{ - Method: "GET", - Host: u.Host, - URL: u, - RequestURI: u.RequestURI(), + cc, err := cfg.GetCluster("") + c.Assert(err, check.IsNil) + s.cluster = cc + s.handler = &handler{ + Cluster: cc, + Cache: cache{ + cluster: cc, + logger: logger, + registry: prometheus.NewRegistry(), + }, } - resp := httptest.NewRecorder() - h.ServeHTTP(resp, req) - c.Check(resp.Code, check.Equals, http.StatusOK) - c.Check(keepclient.DefaultBlockCache.MaxBlocks, check.Equals, cfg.cluster.Collections.WebDAVCache.MaxBlockEntries) } func (s *UnitSuite) TestCORSPreflight(c *check.C) { - h := handler{Config: newConfig(s.Config)} + h := s.handler u := mustParseURL("http://keep-web.example/c=" + arvadostest.FooCollection + "/foo") req := &http.Request{ Method: "OPTIONS", @@ -89,6 +93,64 @@ func (s *UnitSuite) TestCORSPreflight(c *check.C) { c.Check(resp.Code, check.Equals, http.StatusMethodNotAllowed) } +func (s *UnitSuite) TestEmptyResponse(c *check.C) { + for _, trial := range []struct { + dataExists bool + sendIMSHeader bool + expectStatus int + logRegexp string + }{ + // If we return no content due to a Keep read error, + // we should emit a log message. + {false, false, http.StatusOK, `(?ms).*only wrote 0 bytes.*`}, + + // If we return no content because the client sent an + // If-Modified-Since header, our response should be + // 304. We still expect a "File download" log since it + // counts as a file access for auditing. + {true, true, http.StatusNotModified, `(?ms).*msg="File download".*`}, + } { + c.Logf("trial: %+v", trial) + arvadostest.StartKeep(2, true) + if trial.dataExists { + arv, err := arvadosclient.MakeArvadosClient() + c.Assert(err, check.IsNil) + arv.ApiToken = arvadostest.ActiveToken + kc, err := keepclient.MakeKeepClient(arv) + c.Assert(err, check.IsNil) + _, _, err = kc.PutB([]byte("foo")) + c.Assert(err, check.IsNil) + } + + u := mustParseURL("http://" + arvadostest.FooCollection + ".keep-web.example/foo") + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.ActiveToken}, + }, + } + if trial.sendIMSHeader { + req.Header.Set("If-Modified-Since", strings.Replace(time.Now().UTC().Format(time.RFC1123), "UTC", "GMT", -1)) + } + + var logbuf bytes.Buffer + logger := logrus.New() + logger.Out = &logbuf + req = req.WithContext(ctxlog.Context(context.Background(), logger)) + + resp := httptest.NewRecorder() + s.handler.ServeHTTP(resp, req) + c.Check(resp.Code, check.Equals, trial.expectStatus) + c.Check(resp.Body.String(), check.Equals, "") + + c.Log(logbuf.String()) + c.Check(logbuf.String(), check.Matches, trial.logRegexp) + } +} + func (s *UnitSuite) TestInvalidUUID(c *check.C) { bogusID := strings.Replace(arvadostest.FooCollectionPDH, "+", "-", 1) + "-" token := arvadostest.ActiveToken @@ -109,10 +171,8 @@ func (s *UnitSuite) TestInvalidUUID(c *check.C) { RequestURI: u.RequestURI(), } resp := httptest.NewRecorder() - cfg := newConfig(s.Config) - cfg.cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken - h := handler{Config: cfg} - h.ServeHTTP(resp, req) + s.cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusNotFound) } } @@ -137,9 +197,9 @@ func (s *IntegrationSuite) TestVhost404(c *check.C) { URL: u, RequestURI: u.RequestURI(), } - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusNotFound) - c.Check(resp.Body.String(), check.Equals, "") + c.Check(resp.Body.String(), check.Equals, notFoundMessage+"\n") } } @@ -149,11 +209,18 @@ func (s *IntegrationSuite) TestVhost404(c *check.C) { // the token is invalid. type authorizer func(*http.Request, string) int -func (s *IntegrationSuite) TestVhostViaAuthzHeader(c *check.C) { - s.doVhostRequests(c, authzViaAuthzHeader) +func (s *IntegrationSuite) TestVhostViaAuthzHeaderOAuth2(c *check.C) { + s.doVhostRequests(c, authzViaAuthzHeaderOAuth2) } -func authzViaAuthzHeader(r *http.Request, tok string) int { - r.Header.Add("Authorization", "OAuth2 "+tok) +func authzViaAuthzHeaderOAuth2(r *http.Request, tok string) int { + r.Header.Add("Authorization", "Bearer "+tok) + return http.StatusUnauthorized +} +func (s *IntegrationSuite) TestVhostViaAuthzHeaderBearer(c *check.C) { + s.doVhostRequests(c, authzViaAuthzHeaderBearer) +} +func authzViaAuthzHeaderBearer(r *http.Request, tok string) int { + r.Header.Add("Authorization", "Bearer "+tok) return http.StatusUnauthorized } @@ -254,7 +321,6 @@ func (s *IntegrationSuite) doVhostRequestsWithHostPath(c *check.C, authz authori if tok == arvadostest.ActiveToken { c.Check(code, check.Equals, http.StatusOK) c.Check(body, check.Equals, "foo") - } else { c.Check(code >= 400, check.Equals, true) c.Check(code < 500, check.Equals, true) @@ -267,14 +333,60 @@ func (s *IntegrationSuite) doVhostRequestsWithHostPath(c *check.C, authz authori // depending on the authz method. c.Check(code, check.Equals, failCode) } - c.Check(body, check.Equals, "") + if code == 404 { + c.Check(body, check.Equals, notFoundMessage+"\n") + } else { + c.Check(body, check.Equals, unauthorizedMessage+"\n") + } } } } +func (s *IntegrationSuite) TestVhostPortMatch(c *check.C) { + for _, host := range []string{"download.example.com", "DOWNLOAD.EXAMPLE.COM"} { + for _, port := range []string{"80", "443", "8000"} { + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = fmt.Sprintf("download.example.com:%v", port) + u := mustParseURL(fmt.Sprintf("http://%v/by_id/%v/foo", host, arvadostest.FooCollection)) + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{"Authorization": []string{"Bearer " + arvadostest.ActiveToken}}, + } + req, resp := s.doReq(req) + code, _ := resp.Code, resp.Body.String() + + if port == "8000" { + c.Check(code, check.Equals, 401) + } else { + c.Check(code, check.Equals, 200) + } + } + } +} + +func (s *IntegrationSuite) do(method string, urlstring string, token string, hdr http.Header) (*http.Request, *httptest.ResponseRecorder) { + u := mustParseURL(urlstring) + if hdr == nil && token != "" { + hdr = http.Header{"Authorization": {"Bearer " + token}} + } else if hdr == nil { + hdr = http.Header{} + } else if token != "" { + panic("must not pass both token and hdr") + } + return s.doReq(&http.Request{ + Method: method, + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: hdr, + }) +} + func (s *IntegrationSuite) doReq(req *http.Request) (*http.Request, *httptest.ResponseRecorder) { resp := httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) if resp.Code != http.StatusSeeOther { return req, resp } @@ -297,7 +409,7 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenToCookie(c *check.C) { s.testVhostRedirectTokenToCookie(c, "GET", arvadostest.FooCollection+".example.com/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "foo", @@ -308,11 +420,31 @@ func (s *IntegrationSuite) TestSingleOriginSecretLink(c *check.C) { s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.FooCollection+"/t="+arvadostest.ActiveToken+"/foo", "", + nil, "", + http.StatusOK, + "foo", + ) +} + +func (s *IntegrationSuite) TestCollectionSharingToken(c *check.C) { + s.testVhostRedirectTokenToCookie(c, "GET", + "example.com/c="+arvadostest.FooFileCollectionUUID+"/t="+arvadostest.FooFileCollectionSharingToken+"/foo", + "", + nil, "", http.StatusOK, "foo", ) + // Same valid sharing token, but requesting a different collection + s.testVhostRedirectTokenToCookie(c, "GET", + "example.com/c="+arvadostest.FooCollection+"/t="+arvadostest.FooFileCollectionSharingToken+"/foo", + "", + nil, + "", + http.StatusNotFound, + notFoundMessage+"\n", + ) } // Bad token in URL is 404 Not Found because it doesn't make sense to @@ -321,32 +453,109 @@ func (s *IntegrationSuite) TestSingleOriginSecretLinkBadToken(c *check.C) { s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.FooCollection+"/t=bogus/foo", "", - "", + nil, "", http.StatusNotFound, - "", + notFoundMessage+"\n", ) } // Bad token in a cookie (even if it got there via our own -// query-string-to-cookie redirect) is, in principle, retryable at the -// same URL so it's 401 Unauthorized. +// query-string-to-cookie redirect) is, in principle, retryable via +// wb2-login-and-redirect flow. func (s *IntegrationSuite) TestVhostRedirectQueryTokenToBogusCookie(c *check.C) { - s.testVhostRedirectTokenToCookie(c, "GET", + // Inline + resp := s.testVhostRedirectTokenToCookie(c, "GET", arvadostest.FooCollection+".example.com/foo", "?api_token=thisisabogustoken", + http.Header{"Sec-Fetch-Mode": {"navigate"}}, + "", + http.StatusSeeOther, + "", + ) + u, err := url.Parse(resp.Header().Get("Location")) + c.Assert(err, check.IsNil) + c.Logf("redirected to %s", u) + c.Check(u.Host, check.Equals, s.handler.Cluster.Services.Workbench2.ExternalURL.Host) + c.Check(u.Query().Get("redirectToPreview"), check.Equals, "/c="+arvadostest.FooCollection+"/foo") + c.Check(u.Query().Get("redirectToDownload"), check.Equals, "") + + // Download/attachment indicated by ?disposition=attachment + resp = s.testVhostRedirectTokenToCookie(c, "GET", + arvadostest.FooCollection+".example.com/foo", + "?api_token=thisisabogustoken&disposition=attachment", + http.Header{"Sec-Fetch-Mode": {"navigate"}}, + "", + http.StatusSeeOther, + "", + ) + u, err = url.Parse(resp.Header().Get("Location")) + c.Assert(err, check.IsNil) + c.Logf("redirected to %s", u) + c.Check(u.Host, check.Equals, s.handler.Cluster.Services.Workbench2.ExternalURL.Host) + c.Check(u.Query().Get("redirectToPreview"), check.Equals, "") + c.Check(u.Query().Get("redirectToDownload"), check.Equals, "/c="+arvadostest.FooCollection+"/foo") + + // Download/attachment indicated by vhost + resp = s.testVhostRedirectTokenToCookie(c, "GET", + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host+"/c="+arvadostest.FooCollection+"/foo", + "?api_token=thisisabogustoken", + http.Header{"Sec-Fetch-Mode": {"navigate"}}, + "", + http.StatusSeeOther, + "", + ) + u, err = url.Parse(resp.Header().Get("Location")) + c.Assert(err, check.IsNil) + c.Logf("redirected to %s", u) + c.Check(u.Host, check.Equals, s.handler.Cluster.Services.Workbench2.ExternalURL.Host) + c.Check(u.Query().Get("redirectToPreview"), check.Equals, "") + c.Check(u.Query().Get("redirectToDownload"), check.Equals, "/c="+arvadostest.FooCollection+"/foo") + + // Without "Sec-Fetch-Mode: navigate" header, just 401. + s.testVhostRedirectTokenToCookie(c, "GET", + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host+"/c="+arvadostest.FooCollection+"/foo", + "?api_token=thisisabogustoken", + http.Header{"Sec-Fetch-Mode": {"cors"}}, "", + http.StatusUnauthorized, + unauthorizedMessage+"\n", + ) + s.testVhostRedirectTokenToCookie(c, "GET", + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host+"/c="+arvadostest.FooCollection+"/foo", + "?api_token=thisisabogustoken", + nil, "", http.StatusUnauthorized, + unauthorizedMessage+"\n", + ) +} + +func (s *IntegrationSuite) TestVhostRedirectWithNoCache(c *check.C) { + resp := s.testVhostRedirectTokenToCookie(c, "GET", + arvadostest.FooCollection+".example.com/foo", + "?api_token=thisisabogustoken", + http.Header{ + "Sec-Fetch-Mode": {"navigate"}, + "Cache-Control": {"no-cache"}, + }, + "", + http.StatusSeeOther, "", ) + u, err := url.Parse(resp.Header().Get("Location")) + c.Assert(err, check.IsNil) + c.Logf("redirected to %s", u) + c.Check(u.Host, check.Equals, s.handler.Cluster.Services.Workbench2.ExternalURL.Host) + c.Check(u.Query().Get("redirectToPreview"), check.Equals, "/c="+arvadostest.FooCollection+"/foo") + c.Check(u.Query().Get("redirectToDownload"), check.Equals, "") } func (s *IntegrationSuite) TestVhostRedirectQueryTokenSingleOriginError(c *check.C) { s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.FooCollection+"/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusBadRequest, "cannot serve inline content at this URL (possible configuration error; see https://doc.arvados.org/install/install-keep-web.html#dns)\n", @@ -360,7 +569,7 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenRequestAttachment(c *check resp := s.testVhostRedirectTokenToCookie(c, "GET", arvadostest.FooCollection+".example.com/foo", "?disposition=attachment&api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "foo", @@ -369,11 +578,11 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenRequestAttachment(c *check } func (s *IntegrationSuite) TestVhostRedirectQueryTokenSiteFS(c *check.C) { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" resp := s.testVhostRedirectTokenToCookie(c, "GET", "download.example.com/by_id/"+arvadostest.FooCollection+"/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "foo", @@ -382,11 +591,11 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenSiteFS(c *check.C) { } func (s *IntegrationSuite) TestPastCollectionVersionFileAccess(c *check.C) { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" resp := s.testVhostRedirectTokenToCookie(c, "GET", "download.example.com/c="+arvadostest.WazVersion1Collection+"/waz", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "waz", @@ -395,7 +604,7 @@ func (s *IntegrationSuite) TestPastCollectionVersionFileAccess(c *check.C) { resp = s.testVhostRedirectTokenToCookie(c, "GET", "download.example.com/by_id/"+arvadostest.WazVersion1Collection+"/waz", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "waz", @@ -404,11 +613,11 @@ func (s *IntegrationSuite) TestPastCollectionVersionFileAccess(c *check.C) { } func (s *IntegrationSuite) TestVhostRedirectQueryTokenTrustAllContent(c *check.C) { - s.testServer.Config.cluster.Collections.TrustAllContent = true + s.handler.Cluster.Collections.TrustAllContent = true s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.FooCollection+"/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "foo", @@ -416,12 +625,12 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenTrustAllContent(c *check.C } func (s *IntegrationSuite) TestVhostRedirectQueryTokenAttachmentOnlyHost(c *check.C) { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "example.com:1234" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "example.com:1234" s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.FooCollection+"/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusBadRequest, "cannot serve inline content at this URL (possible configuration error; see https://doc.arvados.org/install/install-keep-web.html#dns)\n", @@ -430,7 +639,7 @@ func (s *IntegrationSuite) TestVhostRedirectQueryTokenAttachmentOnlyHost(c *chec resp := s.testVhostRedirectTokenToCookie(c, "GET", "example.com:1234/c="+arvadostest.FooCollection+"/foo", "?api_token="+arvadostest.ActiveToken, - "", + nil, "", http.StatusOK, "foo", @@ -442,7 +651,7 @@ func (s *IntegrationSuite) TestVhostRedirectPOSTFormTokenToCookie(c *check.C) { s.testVhostRedirectTokenToCookie(c, "POST", arvadostest.FooCollection+".example.com/foo", "", - "application/x-www-form-urlencoded", + http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}, url.Values{"api_token": {arvadostest.ActiveToken}}.Encode(), http.StatusOK, "foo", @@ -453,19 +662,19 @@ func (s *IntegrationSuite) TestVhostRedirectPOSTFormTokenToCookie404(c *check.C) s.testVhostRedirectTokenToCookie(c, "POST", arvadostest.FooCollection+".example.com/foo", "", - "application/x-www-form-urlencoded", + http.Header{"Content-Type": {"application/x-www-form-urlencoded"}}, url.Values{"api_token": {arvadostest.SpectatorToken}}.Encode(), http.StatusNotFound, - "", + notFoundMessage+"\n", ) } func (s *IntegrationSuite) TestAnonymousTokenOK(c *check.C) { - s.testServer.Config.cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken + s.handler.Cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.HelloWorldCollection+"/Hello%20world.txt", "", - "", + nil, "", http.StatusOK, "Hello world\n", @@ -473,23 +682,23 @@ func (s *IntegrationSuite) TestAnonymousTokenOK(c *check.C) { } func (s *IntegrationSuite) TestAnonymousTokenError(c *check.C) { - s.testServer.Config.cluster.Users.AnonymousUserToken = "anonymousTokenConfiguredButInvalid" + s.handler.Cluster.Users.AnonymousUserToken = "anonymousTokenConfiguredButInvalid" s.testVhostRedirectTokenToCookie(c, "GET", "example.com/c="+arvadostest.HelloWorldCollection+"/Hello%20world.txt", "", - "", + nil, "", http.StatusNotFound, - "", + notFoundMessage+"\n", ) } func (s *IntegrationSuite) TestSpecialCharsInPath(c *check.C) { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" - client := s.testServer.Config.Client + client := arvados.NewClientFromEnv() client.AuthToken = arvadostest.ActiveToken - fs, err := (&arvados.Collection{}).FileSystem(&client, nil) + fs, err := (&arvados.Collection{}).FileSystem(client, nil) c.Assert(err, check.IsNil) f, err := fs.OpenFile("https:\\\"odd' path chars", os.O_CREATE, 0777) c.Assert(err, check.IsNil) @@ -515,22 +724,22 @@ func (s *IntegrationSuite) TestSpecialCharsInPath(c *check.C) { }, } resp := httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusOK) c.Check(resp.Body.String(), check.Matches, `(?ms).*href="./https:%5c%22odd%27%20path%20chars"\S+https:\\"odd' path chars.*`) } func (s *IntegrationSuite) TestForwardSlashSubstitution(c *check.C) { arv := arvados.NewClientFromEnv() - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" - s.testServer.Config.cluster.Collections.ForwardSlashNameSubstitution = "{SOLIDUS}" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + s.handler.Cluster.Collections.ForwardSlashNameSubstitution = "{SOLIDUS}" name := "foo/bar/baz" nameShown := strings.Replace(name, "/", "{SOLIDUS}", -1) nameShownEscaped := strings.Replace(name, "/", "%7bSOLIDUS%7d", -1) - client := s.testServer.Config.Client + client := arvados.NewClientFromEnv() client.AuthToken = arvadostest.ActiveToken - fs, err := (&arvados.Collection{}).FileSystem(&client, nil) + fs, err := (&arvados.Collection{}).FileSystem(client, nil) c.Assert(err, check.IsNil) f, err := fs.OpenFile("filename", os.O_CREATE, 0777) c.Assert(err, check.IsNil) @@ -550,7 +759,7 @@ func (s *IntegrationSuite) TestForwardSlashSubstitution(c *check.C) { base := "http://download.example.com/by_id/" + coll.OwnerUUID + "/" for tryURL, expectRegexp := range map[string]string{ - base: `(?ms).*href="./` + nameShownEscaped + `/"\S+` + nameShown + `.*`, + base: `(?ms).*href="./` + nameShownEscaped + `/"\S+` + nameShown + `.*`, base + nameShownEscaped + "/": `(?ms).*href="./filename"\S+filename.*`, } { u, _ := url.Parse(tryURL) @@ -564,7 +773,7 @@ func (s *IntegrationSuite) TestForwardSlashSubstitution(c *check.C) { }, } resp := httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusOK) c.Check(resp.Body.String(), check.Matches, expectRegexp) } @@ -592,20 +801,43 @@ func (s *IntegrationSuite) TestXHRNoRedirect(c *check.C) { }.Encode())), } resp := httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) + c.Check(resp.Code, check.Equals, http.StatusOK) + c.Check(resp.Body.String(), check.Equals, "foo") + c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, "*") + + // GET + Origin header is representative of both AJAX GET + // requests and inline images via . + u.RawQuery = "api_token=" + url.QueryEscape(arvadostest.ActiveTokenV2) + req = &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Origin": {"https://origin.example"}, + }, + } + resp = httptest.NewRecorder() + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusOK) c.Check(resp.Body.String(), check.Equals, "foo") c.Check(resp.Header().Get("Access-Control-Allow-Origin"), check.Equals, "*") } -func (s *IntegrationSuite) testVhostRedirectTokenToCookie(c *check.C, method, hostPath, queryString, contentType, reqBody string, expectStatus int, expectRespBody string) *httptest.ResponseRecorder { +func (s *IntegrationSuite) testVhostRedirectTokenToCookie(c *check.C, method, hostPath, queryString string, reqHeader http.Header, reqBody string, expectStatus int, expectRespBody string) *httptest.ResponseRecorder { + if reqHeader == nil { + reqHeader = http.Header{} + } u, _ := url.Parse(`http://` + hostPath + queryString) + c.Logf("requesting %s", u) req := &http.Request{ Method: method, Host: u.Host, URL: u, RequestURI: u.RequestURI(), - Header: http.Header{"Content-Type": {contentType}}, + Header: reqHeader, Body: ioutil.NopCloser(strings.NewReader(reqBody)), } @@ -615,43 +847,49 @@ func (s *IntegrationSuite) testVhostRedirectTokenToCookie(c *check.C, method, ho c.Check(resp.Body.String(), check.Equals, expectRespBody) }() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) if resp.Code != http.StatusSeeOther { return resp } c.Check(resp.Body.String(), check.Matches, `.*href="http://`+regexp.QuoteMeta(html.EscapeString(hostPath))+`(\?[^"]*)?".*`) + c.Check(strings.Split(resp.Header().Get("Location"), "?")[0], check.Equals, "http://"+hostPath) cookies := (&http.Response{Header: resp.Header()}).Cookies() - u, _ = u.Parse(resp.Header().Get("Location")) + u, err := u.Parse(resp.Header().Get("Location")) + c.Assert(err, check.IsNil) + c.Logf("following redirect to %s", u) req = &http.Request{ Method: "GET", Host: u.Host, URL: u, RequestURI: u.RequestURI(), - Header: http.Header{}, + Header: reqHeader, } for _, c := range cookies { req.AddCookie(c) } resp = httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) - c.Check(resp.Header().Get("Location"), check.Equals, "") + s.handler.ServeHTTP(resp, req) + + if resp.Code != http.StatusSeeOther { + c.Check(resp.Header().Get("Location"), check.Equals, "") + } return resp } func (s *IntegrationSuite) TestDirectoryListingWithAnonymousToken(c *check.C) { - s.testServer.Config.cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken + s.handler.Cluster.Users.AnonymousUserToken = arvadostest.AnonymousToken s.testDirectoryListing(c) } func (s *IntegrationSuite) TestDirectoryListingWithNoAnonymousToken(c *check.C) { - s.testServer.Config.cluster.Users.AnonymousUserToken = "" + s.handler.Cluster.Users.AnonymousUserToken = "" s.testDirectoryListing(c) } func (s *IntegrationSuite) testDirectoryListing(c *check.C) { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" authHeader := http.Header{ "Authorization": {"OAuth2 " + arvadostest.ActiveToken}, } @@ -677,7 +915,7 @@ func (s *IntegrationSuite) testDirectoryListing(c *check.C) { { // URLs of this form ignore authHeader, and // FooAndBarFilesInDirUUID isn't public, so - // this returns 404. + // this returns 401. uri: "download.example.com/collections/" + arvadostest.FooAndBarFilesInDirUUID + "/", header: authHeader, expect: nil, @@ -798,7 +1036,7 @@ func (s *IntegrationSuite) testDirectoryListing(c *check.C) { RequestURI: u.RequestURI(), Header: copyHeader(trial.header), } - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) var cookies []*http.Cookie for resp.Code == http.StatusSeeOther { u, _ := req.URL.Parse(resp.Header().Get("Location")) @@ -814,13 +1052,17 @@ func (s *IntegrationSuite) testDirectoryListing(c *check.C) { req.AddCookie(c) } resp = httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) } if trial.redirect != "" { c.Check(req.URL.Path, check.Equals, trial.redirect, comment) } if trial.expect == nil { - c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + if s.handler.Cluster.Users.AnonymousUserToken == "" { + c.Check(resp.Code, check.Equals, http.StatusUnauthorized, comment) + } else { + c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + } } else { c.Check(resp.Code, check.Equals, http.StatusOK, comment) for _, e := range trial.expect { @@ -839,9 +1081,13 @@ func (s *IntegrationSuite) testDirectoryListing(c *check.C) { Body: ioutil.NopCloser(&bytes.Buffer{}), } resp = httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) if trial.expect == nil { - c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + if s.handler.Cluster.Users.AnonymousUserToken == "" { + c.Check(resp.Code, check.Equals, http.StatusUnauthorized, comment) + } else { + c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + } } else { c.Check(resp.Code, check.Equals, http.StatusOK, comment) } @@ -855,9 +1101,13 @@ func (s *IntegrationSuite) testDirectoryListing(c *check.C) { Body: ioutil.NopCloser(&bytes.Buffer{}), } resp = httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) if trial.expect == nil { - c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + if s.handler.Cluster.Users.AnonymousUserToken == "" { + c.Check(resp.Code, check.Equals, http.StatusUnauthorized, comment) + } else { + c.Check(resp.Code, check.Equals, http.StatusNotFound, comment) + } } else { c.Check(resp.Code, check.Equals, http.StatusMultiStatus, comment) for _, e := range trial.expect { @@ -888,7 +1138,7 @@ func (s *IntegrationSuite) TestDeleteLastFile(c *check.C) { var updated arvados.Collection for _, fnm := range []string{"foo.txt", "bar.txt"} { - s.testServer.Config.cluster.Services.WebDAVDownload.ExternalURL.Host = "example.com" + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "example.com" u, _ := url.Parse("http://example.com/c=" + newCollection.UUID + "/" + fnm) req := &http.Request{ Method: "DELETE", @@ -900,7 +1150,7 @@ func (s *IntegrationSuite) TestDeleteLastFile(c *check.C) { }, } resp := httptest.NewRecorder() - s.testServer.Handler.ServeHTTP(resp, req) + s.handler.ServeHTTP(resp, req) c.Check(resp.Code, check.Equals, http.StatusNoContent) updated = arvados.Collection{} @@ -912,25 +1162,136 @@ func (s *IntegrationSuite) TestDeleteLastFile(c *check.C) { c.Check(updated.ManifestText, check.Equals, "") } -func (s *IntegrationSuite) TestHealthCheckPing(c *check.C) { - s.testServer.Config.cluster.ManagementToken = arvadostest.ManagementToken - authHeader := http.Header{ - "Authorization": {"Bearer " + arvadostest.ManagementToken}, +func (s *IntegrationSuite) TestFileContentType(c *check.C) { + s.handler.Cluster.Services.WebDAVDownload.ExternalURL.Host = "download.example.com" + + client := arvados.NewClientFromEnv() + client.AuthToken = arvadostest.ActiveToken + arv, err := arvadosclient.New(client) + c.Assert(err, check.Equals, nil) + kc, err := keepclient.MakeKeepClient(arv) + c.Assert(err, check.Equals, nil) + + fs, err := (&arvados.Collection{}).FileSystem(client, kc) + c.Assert(err, check.IsNil) + + trials := []struct { + filename string + content string + contentType string + }{ + {"picture.txt", "BMX bikes are small this year\n", "text/plain; charset=utf-8"}, + {"picture.bmp", "BMX bikes are small this year\n", "image/(x-ms-)?bmp"}, + {"picture.jpg", "BMX bikes are small this year\n", "image/jpeg"}, + {"picture1", "BMX bikes are small this year\n", "image/bmp"}, // content sniff; "BM" is the magic signature for .bmp + {"picture2", "Cars are small this year\n", "text/plain; charset=utf-8"}, // content sniff + } + for _, trial := range trials { + f, err := fs.OpenFile(trial.filename, os.O_CREATE|os.O_WRONLY, 0777) + c.Assert(err, check.IsNil) + _, err = f.Write([]byte(trial.content)) + c.Assert(err, check.IsNil) + c.Assert(f.Close(), check.IsNil) } + mtxt, err := fs.MarshalManifest(".") + c.Assert(err, check.IsNil) + var coll arvados.Collection + err = client.RequestAndDecode(&coll, "POST", "arvados/v1/collections", nil, map[string]interface{}{ + "collection": map[string]string{ + "manifest_text": mtxt, + }, + }) + c.Assert(err, check.IsNil) + + for _, trial := range trials { + u, _ := url.Parse("http://download.example.com/by_id/" + coll.UUID + "/" + trial.filename) + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + client.AuthToken}, + }, + } + resp := httptest.NewRecorder() + s.handler.ServeHTTP(resp, req) + c.Check(resp.Code, check.Equals, http.StatusOK) + c.Check(resp.Header().Get("Content-Type"), check.Matches, trial.contentType) + c.Check(resp.Body.String(), check.Equals, trial.content) + } +} +func (s *IntegrationSuite) TestKeepClientBlockCache(c *check.C) { + s.handler.Cluster.Collections.WebDAVCache.MaxBlockEntries = 42 + c.Check(keepclient.DefaultBlockCache.MaxBlocks, check.Not(check.Equals), 42) + u := mustParseURL("http://keep-web.example/c=" + arvadostest.FooCollection + "/t=" + arvadostest.ActiveToken + "/foo") + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + } resp := httptest.NewRecorder() - u := mustParseURL("http://download.example.com/_health/ping") + s.handler.ServeHTTP(resp, req) + c.Check(resp.Code, check.Equals, http.StatusOK) + c.Check(keepclient.DefaultBlockCache.MaxBlocks, check.Equals, 42) +} + +// Writing to a collection shouldn't affect its entry in the +// PDH-to-manifest cache. +func (s *IntegrationSuite) TestCacheWriteCollectionSamePDH(c *check.C) { + arv, err := arvadosclient.MakeArvadosClient() + c.Assert(err, check.Equals, nil) + arv.ApiToken = arvadostest.ActiveToken + + u := mustParseURL("http://x.example/testfile") req := &http.Request{ Method: "GET", Host: u.Host, URL: u, RequestURI: u.RequestURI(), - Header: authHeader, + Header: http.Header{"Authorization": {"Bearer " + arv.ApiToken}}, } - s.testServer.Handler.ServeHTTP(resp, req) - c.Check(resp.Code, check.Equals, http.StatusOK) - c.Check(resp.Body.String(), check.Matches, `{"health":"OK"}\n`) + checkWithID := func(id string, status int) { + req.URL.Host = strings.Replace(id, "+", "-", -1) + ".example" + req.Host = req.URL.Host + resp := httptest.NewRecorder() + s.handler.ServeHTTP(resp, req) + c.Check(resp.Code, check.Equals, status) + } + + var colls [2]arvados.Collection + for i := range colls { + err := arv.Create("collections", + map[string]interface{}{ + "ensure_unique_name": true, + "collection": map[string]interface{}{ + "name": "test collection", + }, + }, &colls[i]) + c.Assert(err, check.Equals, nil) + } + + // Populate cache with empty collection + checkWithID(colls[0].PortableDataHash, http.StatusNotFound) + + // write a file to colls[0] + reqPut := *req + reqPut.Method = "PUT" + reqPut.URL.Host = colls[0].UUID + ".example" + reqPut.Host = req.URL.Host + reqPut.Body = ioutil.NopCloser(bytes.NewBufferString("testdata")) + resp := httptest.NewRecorder() + s.handler.ServeHTTP(resp, &reqPut) + c.Check(resp.Code, check.Equals, http.StatusCreated) + + // new file should not appear in colls[1] + checkWithID(colls[1].PortableDataHash, http.StatusNotFound) + checkWithID(colls[1].UUID, http.StatusNotFound) + + checkWithID(colls[0].UUID, http.StatusOK) } func copyHeader(h http.Header) http.Header { @@ -940,3 +1301,189 @@ func copyHeader(h http.Header) http.Header { } return hc } + +func (s *IntegrationSuite) checkUploadDownloadRequest(c *check.C, req *http.Request, + successCode int, direction string, perm bool, userUuid, collectionUuid, collectionPDH, filepath string) { + + client := arvados.NewClientFromEnv() + client.AuthToken = arvadostest.AdminToken + var logentries arvados.LogList + limit1 := 1 + err := client.RequestAndDecode(&logentries, "GET", "arvados/v1/logs", nil, + arvados.ResourceListParams{ + Limit: &limit1, + Order: "created_at desc"}) + c.Check(err, check.IsNil) + c.Check(logentries.Items, check.HasLen, 1) + lastLogId := logentries.Items[0].ID + c.Logf("lastLogId: %d", lastLogId) + + var logbuf bytes.Buffer + logger := logrus.New() + logger.Out = &logbuf + resp := httptest.NewRecorder() + req = req.WithContext(ctxlog.Context(context.Background(), logger)) + s.handler.ServeHTTP(resp, req) + + if perm { + c.Check(resp.Result().StatusCode, check.Equals, successCode) + c.Check(logbuf.String(), check.Matches, `(?ms).*msg="File `+direction+`".*`) + c.Check(logbuf.String(), check.Not(check.Matches), `(?ms).*level=error.*`) + + deadline := time.Now().Add(time.Second) + for { + c.Assert(time.Now().After(deadline), check.Equals, false, check.Commentf("timed out waiting for log entry")) + logentries = arvados.LogList{} + err = client.RequestAndDecode(&logentries, "GET", "arvados/v1/logs", nil, + arvados.ResourceListParams{ + Filters: []arvados.Filter{ + {Attr: "event_type", Operator: "=", Operand: "file_" + direction}, + {Attr: "object_uuid", Operator: "=", Operand: userUuid}, + }, + Limit: &limit1, + Order: "created_at desc", + }) + c.Assert(err, check.IsNil) + if len(logentries.Items) > 0 && + logentries.Items[0].ID > lastLogId && + logentries.Items[0].ObjectUUID == userUuid && + logentries.Items[0].Properties["collection_uuid"] == collectionUuid && + (collectionPDH == "" || logentries.Items[0].Properties["portable_data_hash"] == collectionPDH) && + logentries.Items[0].Properties["collection_file_path"] == filepath { + break + } + c.Logf("logentries.Items: %+v", logentries.Items) + time.Sleep(50 * time.Millisecond) + } + } else { + c.Check(resp.Result().StatusCode, check.Equals, http.StatusForbidden) + c.Check(logbuf.String(), check.Equals, "") + } +} + +func (s *IntegrationSuite) TestDownloadLoggingPermission(c *check.C) { + u := mustParseURL("http://" + arvadostest.FooCollection + ".keep-web.example/foo") + + s.handler.Cluster.Collections.TrustAllContent = true + + for _, adminperm := range []bool{true, false} { + for _, userperm := range []bool{true, false} { + s.handler.Cluster.Collections.WebDAVPermission.Admin.Download = adminperm + s.handler.Cluster.Collections.WebDAVPermission.User.Download = userperm + + // Test admin permission + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.AdminToken}, + }, + } + s.checkUploadDownloadRequest(c, req, http.StatusOK, "download", adminperm, + arvadostest.AdminUserUUID, arvadostest.FooCollection, arvadostest.FooCollectionPDH, "foo") + + // Test user permission + req = &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.ActiveToken}, + }, + } + s.checkUploadDownloadRequest(c, req, http.StatusOK, "download", userperm, + arvadostest.ActiveUserUUID, arvadostest.FooCollection, arvadostest.FooCollectionPDH, "foo") + } + } + + s.handler.Cluster.Collections.WebDAVPermission.User.Download = true + + for _, tryurl := range []string{"http://" + arvadostest.MultilevelCollection1 + ".keep-web.example/dir1/subdir/file1", + "http://keep-web/users/active/multilevel_collection_1/dir1/subdir/file1"} { + + u = mustParseURL(tryurl) + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.ActiveToken}, + }, + } + s.checkUploadDownloadRequest(c, req, http.StatusOK, "download", true, + arvadostest.ActiveUserUUID, arvadostest.MultilevelCollection1, arvadostest.MultilevelCollection1PDH, "dir1/subdir/file1") + } + + u = mustParseURL("http://" + strings.Replace(arvadostest.FooCollectionPDH, "+", "-", 1) + ".keep-web.example/foo") + req := &http.Request{ + Method: "GET", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.ActiveToken}, + }, + } + s.checkUploadDownloadRequest(c, req, http.StatusOK, "download", true, + arvadostest.ActiveUserUUID, "", arvadostest.FooCollectionPDH, "foo") +} + +func (s *IntegrationSuite) TestUploadLoggingPermission(c *check.C) { + for _, adminperm := range []bool{true, false} { + for _, userperm := range []bool{true, false} { + + arv := arvados.NewClientFromEnv() + arv.AuthToken = arvadostest.ActiveToken + + var coll arvados.Collection + err := arv.RequestAndDecode(&coll, + "POST", + "/arvados/v1/collections", + nil, + map[string]interface{}{ + "ensure_unique_name": true, + "collection": map[string]interface{}{ + "name": "test collection", + }, + }) + c.Assert(err, check.Equals, nil) + + u := mustParseURL("http://" + coll.UUID + ".keep-web.example/bar") + + s.handler.Cluster.Collections.WebDAVPermission.Admin.Upload = adminperm + s.handler.Cluster.Collections.WebDAVPermission.User.Upload = userperm + + // Test admin permission + req := &http.Request{ + Method: "PUT", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.AdminToken}, + }, + Body: io.NopCloser(bytes.NewReader([]byte("bar"))), + } + s.checkUploadDownloadRequest(c, req, http.StatusCreated, "upload", adminperm, + arvadostest.AdminUserUUID, coll.UUID, "", "bar") + + // Test user permission + req = &http.Request{ + Method: "PUT", + Host: u.Host, + URL: u, + RequestURI: u.RequestURI(), + Header: http.Header{ + "Authorization": {"Bearer " + arvadostest.ActiveToken}, + }, + Body: io.NopCloser(bytes.NewReader([]byte("bar"))), + } + s.checkUploadDownloadRequest(c, req, http.StatusCreated, "upload", userperm, + arvadostest.ActiveUserUUID, coll.UUID, "", "bar") + } + } +}