1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
20 "git.arvados.org/arvados.git/lib/config"
21 "git.arvados.org/arvados.git/lib/controller/localdb"
22 "git.arvados.org/arvados.git/lib/controller/rpc"
23 "git.arvados.org/arvados.git/sdk/go/arvados"
24 "git.arvados.org/arvados.git/sdk/go/auth"
25 "git.arvados.org/arvados.git/sdk/go/ctxlog"
29 cluster *arvados.Cluster
31 remotes map[string]backend
34 func New(cluster *arvados.Cluster) *Conn {
35 local := localdb.NewConn(cluster)
36 remotes := map[string]backend{}
37 for id, remote := range cluster.RemoteClusters {
38 if !remote.Proxy || id == cluster.ClusterID {
41 conn := rpc.NewConn(id, &url.URL{Scheme: remote.Scheme, Host: remote.Host}, remote.Insecure, saltedTokenProvider(local, id))
42 // Older versions of controller rely on the Via header
44 conn.SendHeader = http.Header{"Via": {"HTTP/1.1 arvados-controller"}}
55 // Return a new rpc.TokenProvider that takes the client-provided
56 // tokens from an incoming request context, determines whether they
57 // should (and can) be salted for the given remoteID, and returns the
59 func saltedTokenProvider(local backend, remoteID string) rpc.TokenProvider {
60 return func(ctx context.Context) ([]string, error) {
62 incoming, ok := auth.FromContext(ctx)
64 return nil, errors.New("no token provided")
66 for _, token := range incoming.Tokens {
67 salted, err := auth.SaltToken(token, remoteID)
70 tokens = append(tokens, salted)
72 tokens = append(tokens, token)
73 case auth.ErrObsoleteToken:
74 ctx := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{token}})
75 aca, err := local.APIClientAuthorizationCurrent(ctx, arvados.GetOptions{})
76 if errStatus(err) == http.StatusUnauthorized {
77 // pass through unmodified
78 tokens = append(tokens, token)
80 } else if err != nil {
83 if strings.HasPrefix(aca.UUID, remoteID) {
84 // We have it cached here, but
85 // the token belongs to the
86 // remote target itself, so
87 // pass it through unmodified.
88 tokens = append(tokens, token)
91 salted, err := auth.SaltToken(aca.TokenV2(), remoteID)
95 tokens = append(tokens, salted)
104 // Return suitable backend for a query about the given cluster ID
105 // ("aaaaa") or object UUID ("aaaaa-dz642-abcdefghijklmno").
106 func (conn *Conn) chooseBackend(id string) backend {
109 } else if len(id) != 5 {
113 if id == conn.cluster.ClusterID {
115 } else if be, ok := conn.remotes[id]; ok {
118 // TODO: return an "always error" backend?
123 func (conn *Conn) localOrLoginCluster() backend {
124 if conn.cluster.Login.LoginCluster != "" {
125 return conn.chooseBackend(conn.cluster.Login.LoginCluster)
130 // Call fn with the local backend; then, if fn returned 404, call fn
131 // on the available remote backends (possibly concurrently) until one
134 // The second argument to fn is the cluster ID of the remote backend,
135 // or "" for the local backend.
137 // A non-nil error means all backends failed.
138 func (conn *Conn) tryLocalThenRemotes(ctx context.Context, forwardedFor string, fn func(context.Context, string, backend) error) error {
139 if err := fn(ctx, "", conn.local); err == nil || errStatus(err) != http.StatusNotFound || forwardedFor != "" {
140 // Note: forwardedFor != "" means this request came
141 // from a remote cluster, so we don't take a second
142 // hop. This avoids cycles, redundant calls to a
143 // mutually reachable remote, and use of double-salted
148 ctx, cancel := context.WithCancel(ctx)
150 errchan := make(chan error, len(conn.remotes))
151 for remoteID, be := range conn.remotes {
152 remoteID, be := remoteID, be
154 errchan <- fn(ctx, remoteID, be)
159 for i := 0; i < cap(errchan); i++ {
164 all404 = all404 && errStatus(err) == http.StatusNotFound
165 errs = append(errs, err)
168 return notFoundError{}
170 return httpErrorf(http.StatusBadGateway, "errors: %v", errs)
173 func (conn *Conn) CollectionCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Collection, error) {
174 return conn.chooseBackend(options.ClusterID).CollectionCreate(ctx, options)
177 func (conn *Conn) CollectionUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Collection, error) {
178 return conn.chooseBackend(options.UUID).CollectionUpdate(ctx, options)
181 func rewriteManifest(mt, remoteID string) string {
182 return regexp.MustCompile(` [0-9a-f]{32}\+[^ ]*`).ReplaceAllStringFunc(mt, func(tok string) string {
183 return strings.Replace(tok, "+A", "+R"+remoteID+"-", -1)
187 func (conn *Conn) ConfigGet(ctx context.Context) (json.RawMessage, error) {
189 err := config.ExportJSON(&buf, conn.cluster)
190 return json.RawMessage(buf.Bytes()), err
193 func (conn *Conn) Login(ctx context.Context, options arvados.LoginOptions) (arvados.LoginResponse, error) {
194 if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID {
195 // defer entire login procedure to designated cluster
196 remote, ok := conn.remotes[id]
198 return arvados.LoginResponse{}, fmt.Errorf("configuration problem: designated login cluster %q is not defined", id)
200 baseURL := remote.BaseURL()
201 target, err := baseURL.Parse(arvados.EndpointLogin.Path)
203 return arvados.LoginResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
205 params := url.Values{
206 "return_to": []string{options.ReturnTo},
208 if options.Remote != "" {
209 params.Set("remote", options.Remote)
211 target.RawQuery = params.Encode()
212 return arvados.LoginResponse{
213 RedirectLocation: target.String(),
216 return conn.local.Login(ctx, options)
219 func (conn *Conn) Logout(ctx context.Context, options arvados.LogoutOptions) (arvados.LogoutResponse, error) {
220 // If the logout request comes with an API token from a known
221 // remote cluster, redirect to that cluster's logout handler
222 // so it has an opportunity to clear sessions, expire tokens,
223 // etc. Otherwise use the local endpoint.
224 reqauth, ok := auth.FromContext(ctx)
225 if !ok || len(reqauth.Tokens) == 0 || len(reqauth.Tokens[0]) < 8 || !strings.HasPrefix(reqauth.Tokens[0], "v2/") {
226 return conn.local.Logout(ctx, options)
228 id := reqauth.Tokens[0][3:8]
229 if id == conn.cluster.ClusterID {
230 return conn.local.Logout(ctx, options)
232 remote, ok := conn.remotes[id]
234 return conn.local.Logout(ctx, options)
236 baseURL := remote.BaseURL()
237 target, err := baseURL.Parse(arvados.EndpointLogout.Path)
239 return arvados.LogoutResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
241 target.RawQuery = url.Values{"return_to": {options.ReturnTo}}.Encode()
242 return arvados.LogoutResponse{RedirectLocation: target.String()}, nil
245 func (conn *Conn) CollectionGet(ctx context.Context, options arvados.GetOptions) (arvados.Collection, error) {
246 if len(options.UUID) == 27 {
247 // UUID is really a UUID
248 c, err := conn.chooseBackend(options.UUID).CollectionGet(ctx, options)
249 if err == nil && options.UUID[:5] != conn.cluster.ClusterID {
250 c.ManifestText = rewriteManifest(c.ManifestText, options.UUID[:5])
255 first := make(chan arvados.Collection, 1)
256 err := conn.tryLocalThenRemotes(ctx, options.ForwardedFor, func(ctx context.Context, remoteID string, be backend) error {
257 remoteOpts := options
258 remoteOpts.ForwardedFor = conn.cluster.ClusterID + "-" + options.ForwardedFor
259 c, err := be.CollectionGet(ctx, remoteOpts)
263 // options.UUID is either hash+size or
264 // hash+size+hints; only hash+size need to
265 // match the computed PDH.
266 if pdh := arvados.PortableDataHash(c.ManifestText); pdh != options.UUID && !strings.HasPrefix(options.UUID, pdh+"+") {
267 err = httpErrorf(http.StatusBadGateway, "bad portable data hash %q received from remote %q (expected %q)", pdh, remoteID, options.UUID)
268 ctxlog.FromContext(ctx).Warn(err)
272 c.ManifestText = rewriteManifest(c.ManifestText, remoteID)
278 // lost race, return value doesn't matter
283 return arvados.Collection{}, err
288 func (conn *Conn) CollectionList(ctx context.Context, options arvados.ListOptions) (arvados.CollectionList, error) {
289 return conn.generated_CollectionList(ctx, options)
292 func (conn *Conn) CollectionProvenance(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
293 return conn.chooseBackend(options.UUID).CollectionProvenance(ctx, options)
296 func (conn *Conn) CollectionUsedBy(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
297 return conn.chooseBackend(options.UUID).CollectionUsedBy(ctx, options)
300 func (conn *Conn) CollectionDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
301 return conn.chooseBackend(options.UUID).CollectionDelete(ctx, options)
304 func (conn *Conn) CollectionTrash(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
305 return conn.chooseBackend(options.UUID).CollectionTrash(ctx, options)
308 func (conn *Conn) CollectionUntrash(ctx context.Context, options arvados.UntrashOptions) (arvados.Collection, error) {
309 return conn.chooseBackend(options.UUID).CollectionUntrash(ctx, options)
312 func (conn *Conn) ContainerList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerList, error) {
313 return conn.generated_ContainerList(ctx, options)
316 func (conn *Conn) ContainerCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Container, error) {
317 return conn.chooseBackend(options.ClusterID).ContainerCreate(ctx, options)
320 func (conn *Conn) ContainerUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Container, error) {
321 return conn.chooseBackend(options.UUID).ContainerUpdate(ctx, options)
324 func (conn *Conn) ContainerGet(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
325 return conn.chooseBackend(options.UUID).ContainerGet(ctx, options)
328 func (conn *Conn) ContainerDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Container, error) {
329 return conn.chooseBackend(options.UUID).ContainerDelete(ctx, options)
332 func (conn *Conn) ContainerLock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
333 return conn.chooseBackend(options.UUID).ContainerLock(ctx, options)
336 func (conn *Conn) ContainerUnlock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
337 return conn.chooseBackend(options.UUID).ContainerUnlock(ctx, options)
340 func (conn *Conn) ContainerRequestList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerRequestList, error) {
341 return conn.generated_ContainerRequestList(ctx, options)
344 func (conn *Conn) ContainerRequestCreate(ctx context.Context, options arvados.CreateOptions) (arvados.ContainerRequest, error) {
345 be := conn.chooseBackend(options.ClusterID)
346 log.Printf("THIS IS federation.Conn.ContainerRequestCreate() for %s we are %s", options.ClusterID, conn.cluster.ClusterID)
347 if be == conn.local {
348 return be.ContainerRequestCreate(ctx, options)
350 if _, ok := options.Attrs["runtime_token"]; !ok {
351 // If runtime_token is not set, create a new token
352 aca, err := conn.local.APIClientAuthorizationCurrent(ctx, arvados.GetOptions{})
354 // This should probably be StatusUnauthorized
355 // (need to update test in
356 // lib/controller/federation_test.go):
357 // When RoR is out of the picture this should be:
358 // return arvados.ContainerRequest{}, httpErrorf(http.StatusUnauthorized, "%w", err)
359 return arvados.ContainerRequest{}, httpErrorf(http.StatusForbidden, "%s", "invalid API token")
361 user, err := conn.local.UserGetCurrent(ctx, arvados.GetOptions{})
363 return arvados.ContainerRequest{}, err
365 if len(aca.Scopes) == 0 || aca.Scopes[0] != "all" {
366 return arvados.ContainerRequest{}, httpErrorf(http.StatusForbidden, "token scope is not [all]")
368 if strings.HasPrefix(aca.UUID, conn.cluster.ClusterID) {
369 // Local user, submitting to a remote cluster.
370 // Create a new (FIXME: needs to be
371 // time-limited!) token.
372 local, ok := conn.local.(*localdb.Conn)
374 return arvados.ContainerRequest{}, httpErrorf(http.StatusInternalServerError, "bug: local backend is a %T, not a *localdb.Conn", conn.local)
376 aca, err = local.CreateAPIClientAuthorization(ctx, conn.cluster.SystemRootToken, rpc.UserSessionAuthInfo{UserUUID: user.UUID})
378 return arvados.ContainerRequest{}, err
380 options.Attrs["runtime_token"] = aca.TokenV2()
382 // Remote user. Container request will use the
383 // current token, minus the trailing portion
384 // (optional container uuid).
385 options.Attrs["runtime_token"] = aca.TokenV2()
388 return be.ContainerRequestCreate(ctx, options)
391 func (conn *Conn) ContainerRequestUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.ContainerRequest, error) {
392 return conn.chooseBackend(options.UUID).ContainerRequestUpdate(ctx, options)
395 func (conn *Conn) ContainerRequestGet(ctx context.Context, options arvados.GetOptions) (arvados.ContainerRequest, error) {
396 return conn.chooseBackend(options.UUID).ContainerRequestGet(ctx, options)
399 func (conn *Conn) ContainerRequestDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.ContainerRequest, error) {
400 return conn.chooseBackend(options.UUID).ContainerRequestDelete(ctx, options)
403 func (conn *Conn) SpecimenList(ctx context.Context, options arvados.ListOptions) (arvados.SpecimenList, error) {
404 return conn.generated_SpecimenList(ctx, options)
407 func (conn *Conn) SpecimenCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Specimen, error) {
408 return conn.chooseBackend(options.ClusterID).SpecimenCreate(ctx, options)
411 func (conn *Conn) SpecimenUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Specimen, error) {
412 return conn.chooseBackend(options.UUID).SpecimenUpdate(ctx, options)
415 func (conn *Conn) SpecimenGet(ctx context.Context, options arvados.GetOptions) (arvados.Specimen, error) {
416 return conn.chooseBackend(options.UUID).SpecimenGet(ctx, options)
419 func (conn *Conn) SpecimenDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Specimen, error) {
420 return conn.chooseBackend(options.UUID).SpecimenDelete(ctx, options)
423 var userAttrsCachedFromLoginCluster = map[string]bool{
436 "identity_url": false,
438 "modified_by_client_uuid": false,
439 "modified_by_user_uuid": false,
442 "writable_by": false,
445 func (conn *Conn) batchUpdateUsers(ctx context.Context,
446 options arvados.ListOptions,
447 items []arvados.User) (err error) {
449 id := conn.cluster.Login.LoginCluster
450 logger := ctxlog.FromContext(ctx)
451 batchOpts := arvados.UserBatchUpdateOptions{Updates: map[string]map[string]interface{}{}}
452 for _, user := range items {
453 if !strings.HasPrefix(user.UUID, id) {
456 logger.Debugf("cache user info for uuid %q", user.UUID)
458 // If the remote cluster has null timestamps
459 // (e.g., test server with incomplete
460 // fixtures) use dummy timestamps (instead of
461 // the zero time, which causes a Rails API
462 // error "year too big to marshal: 1 UTC").
463 if user.ModifiedAt.IsZero() {
464 user.ModifiedAt = time.Now()
466 if user.CreatedAt.IsZero() {
467 user.CreatedAt = time.Now()
470 var allFields map[string]interface{}
471 buf, err := json.Marshal(user)
473 return fmt.Errorf("error encoding user record from remote response: %s", err)
475 err = json.Unmarshal(buf, &allFields)
477 return fmt.Errorf("error transcoding user record from remote response: %s", err)
480 if len(options.Select) > 0 {
481 updates = map[string]interface{}{}
482 for _, k := range options.Select {
483 if v, ok := allFields[k]; ok && userAttrsCachedFromLoginCluster[k] {
488 for k := range updates {
489 if !userAttrsCachedFromLoginCluster[k] {
494 batchOpts.Updates[user.UUID] = updates
496 if len(batchOpts.Updates) > 0 {
497 ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{conn.cluster.SystemRootToken}})
498 _, err = conn.local.UserBatchUpdate(ctxRoot, batchOpts)
500 return fmt.Errorf("error updating local user records: %s", err)
506 func (conn *Conn) UserList(ctx context.Context, options arvados.ListOptions) (arvados.UserList, error) {
507 if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID && !options.BypassFederation {
508 resp, err := conn.chooseBackend(id).UserList(ctx, options)
512 err = conn.batchUpdateUsers(ctx, options, resp.Items)
514 return arvados.UserList{}, err
518 return conn.generated_UserList(ctx, options)
521 func (conn *Conn) UserCreate(ctx context.Context, options arvados.CreateOptions) (arvados.User, error) {
522 return conn.chooseBackend(options.ClusterID).UserCreate(ctx, options)
525 func (conn *Conn) UserUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.User, error) {
526 if options.BypassFederation {
527 return conn.local.UserUpdate(ctx, options)
529 resp, err := conn.chooseBackend(options.UUID).UserUpdate(ctx, options)
533 if options.UUID[:5] != conn.cluster.ClusterID {
534 // Copy the updated user record to the local cluster
535 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{}, []arvados.User{resp})
537 return arvados.User{}, err
543 func (conn *Conn) UserUpdateUUID(ctx context.Context, options arvados.UpdateUUIDOptions) (arvados.User, error) {
544 return conn.local.UserUpdateUUID(ctx, options)
547 func (conn *Conn) UserMerge(ctx context.Context, options arvados.UserMergeOptions) (arvados.User, error) {
548 return conn.local.UserMerge(ctx, options)
551 func (conn *Conn) UserActivate(ctx context.Context, options arvados.UserActivateOptions) (arvados.User, error) {
552 return conn.localOrLoginCluster().UserActivate(ctx, options)
555 func (conn *Conn) UserSetup(ctx context.Context, options arvados.UserSetupOptions) (map[string]interface{}, error) {
556 upstream := conn.localOrLoginCluster()
557 if upstream != conn.local {
558 // When LoginCluster is in effect, and we're setting
559 // up a remote user, and we want to give that user
560 // access to a local VM, we can't include the VM in
561 // the setup call, because the remote cluster won't
564 // Similarly, if we want to create a git repo,
565 // it should be created on the local cluster,
566 // not the remote one.
568 upstreamOptions := options
569 upstreamOptions.VMUUID = ""
570 upstreamOptions.RepoName = ""
572 ret, err := upstream.UserSetup(ctx, upstreamOptions)
578 return conn.local.UserSetup(ctx, options)
581 func (conn *Conn) UserUnsetup(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
582 return conn.localOrLoginCluster().UserUnsetup(ctx, options)
585 func (conn *Conn) UserGet(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
586 resp, err := conn.chooseBackend(options.UUID).UserGet(ctx, options)
590 if options.UUID != resp.UUID {
591 return arvados.User{}, httpErrorf(http.StatusBadGateway, "Had requested %v but response was for %v", options.UUID, resp.UUID)
593 if options.UUID[:5] != conn.cluster.ClusterID {
594 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{Select: options.Select}, []arvados.User{resp})
596 return arvados.User{}, err
602 func (conn *Conn) UserGetCurrent(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
603 return conn.local.UserGetCurrent(ctx, options)
606 func (conn *Conn) UserGetSystem(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
607 return conn.chooseBackend(options.UUID).UserGetSystem(ctx, options)
610 func (conn *Conn) UserDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.User, error) {
611 return conn.chooseBackend(options.UUID).UserDelete(ctx, options)
614 func (conn *Conn) UserBatchUpdate(ctx context.Context, options arvados.UserBatchUpdateOptions) (arvados.UserList, error) {
615 return conn.local.UserBatchUpdate(ctx, options)
618 func (conn *Conn) UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
619 return conn.local.UserAuthenticate(ctx, options)
622 func (conn *Conn) APIClientAuthorizationCurrent(ctx context.Context, options arvados.GetOptions) (arvados.APIClientAuthorization, error) {
623 return conn.chooseBackend(options.UUID).APIClientAuthorizationCurrent(ctx, options)
626 type backend interface {
631 type notFoundError struct{}
633 func (notFoundError) HTTPStatus() int { return http.StatusNotFound }
634 func (notFoundError) Error() string { return "not found" }
636 func errStatus(err error) int {
637 if httpErr, ok := err.(interface{ HTTPStatus() int }); ok {
638 return httpErr.HTTPStatus()
640 return http.StatusInternalServerError