1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
19 "git.arvados.org/arvados.git/lib/config"
20 "git.arvados.org/arvados.git/lib/controller/localdb"
21 "git.arvados.org/arvados.git/lib/controller/rpc"
22 "git.arvados.org/arvados.git/sdk/go/arvados"
23 "git.arvados.org/arvados.git/sdk/go/auth"
24 "git.arvados.org/arvados.git/sdk/go/ctxlog"
28 cluster *arvados.Cluster
30 remotes map[string]backend
33 func New(cluster *arvados.Cluster) *Conn {
34 local := localdb.NewConn(cluster)
35 remotes := map[string]backend{}
36 for id, remote := range cluster.RemoteClusters {
37 if !remote.Proxy || id == cluster.ClusterID {
40 conn := rpc.NewConn(id, &url.URL{Scheme: remote.Scheme, Host: remote.Host}, remote.Insecure, saltedTokenProvider(local, id))
41 // Older versions of controller rely on the Via header
43 conn.SendHeader = http.Header{"Via": {"HTTP/1.1 arvados-controller"}}
54 // Return a new rpc.TokenProvider that takes the client-provided
55 // tokens from an incoming request context, determines whether they
56 // should (and can) be salted for the given remoteID, and returns the
58 func saltedTokenProvider(local backend, remoteID string) rpc.TokenProvider {
59 return func(ctx context.Context) ([]string, error) {
61 incoming, ok := auth.FromContext(ctx)
63 return nil, errors.New("no token provided")
65 for _, token := range incoming.Tokens {
66 salted, err := auth.SaltToken(token, remoteID)
69 tokens = append(tokens, salted)
71 tokens = append(tokens, token)
72 case auth.ErrObsoleteToken:
73 ctx := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{token}})
74 aca, err := local.APIClientAuthorizationCurrent(ctx, arvados.GetOptions{})
75 if errStatus(err) == http.StatusUnauthorized {
76 // pass through unmodified
77 tokens = append(tokens, token)
79 } else if err != nil {
82 if strings.HasPrefix(aca.UUID, remoteID) {
83 // We have it cached here, but
84 // the token belongs to the
85 // remote target itself, so
86 // pass it through unmodified.
87 tokens = append(tokens, token)
90 salted, err := auth.SaltToken(aca.TokenV2(), remoteID)
94 tokens = append(tokens, salted)
103 // Return suitable backend for a query about the given cluster ID
104 // ("aaaaa") or object UUID ("aaaaa-dz642-abcdefghijklmno").
105 func (conn *Conn) chooseBackend(id string) backend {
108 } else if len(id) != 5 {
112 if id == conn.cluster.ClusterID {
114 } else if be, ok := conn.remotes[id]; ok {
117 // TODO: return an "always error" backend?
122 func (conn *Conn) localOrLoginCluster() backend {
123 if conn.cluster.Login.LoginCluster != "" {
124 return conn.chooseBackend(conn.cluster.Login.LoginCluster)
129 // Call fn with the local backend; then, if fn returned 404, call fn
130 // on the available remote backends (possibly concurrently) until one
133 // The second argument to fn is the cluster ID of the remote backend,
134 // or "" for the local backend.
136 // A non-nil error means all backends failed.
137 func (conn *Conn) tryLocalThenRemotes(ctx context.Context, forwardedFor string, fn func(context.Context, string, backend) error) error {
138 if err := fn(ctx, "", conn.local); err == nil || errStatus(err) != http.StatusNotFound || forwardedFor != "" {
139 // Note: forwardedFor != "" means this request came
140 // from a remote cluster, so we don't take a second
141 // hop. This avoids cycles, redundant calls to a
142 // mutually reachable remote, and use of double-salted
147 ctx, cancel := context.WithCancel(ctx)
149 errchan := make(chan error, len(conn.remotes))
150 for remoteID, be := range conn.remotes {
151 remoteID, be := remoteID, be
153 errchan <- fn(ctx, remoteID, be)
158 for i := 0; i < cap(errchan); i++ {
163 all404 = all404 && errStatus(err) == http.StatusNotFound
164 errs = append(errs, err)
167 return notFoundError{}
169 return httpErrorf(http.StatusBadGateway, "errors: %v", errs)
172 func (conn *Conn) CollectionCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Collection, error) {
173 return conn.chooseBackend(options.ClusterID).CollectionCreate(ctx, options)
176 func (conn *Conn) CollectionUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Collection, error) {
177 return conn.chooseBackend(options.UUID).CollectionUpdate(ctx, options)
180 func rewriteManifest(mt, remoteID string) string {
181 return regexp.MustCompile(` [0-9a-f]{32}\+[^ ]*`).ReplaceAllStringFunc(mt, func(tok string) string {
182 return strings.Replace(tok, "+A", "+R"+remoteID+"-", -1)
186 func (conn *Conn) ConfigGet(ctx context.Context) (json.RawMessage, error) {
188 err := config.ExportJSON(&buf, conn.cluster)
189 return json.RawMessage(buf.Bytes()), err
192 func (conn *Conn) Login(ctx context.Context, options arvados.LoginOptions) (arvados.LoginResponse, error) {
193 if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID {
194 // defer entire login procedure to designated cluster
195 remote, ok := conn.remotes[id]
197 return arvados.LoginResponse{}, fmt.Errorf("configuration problem: designated login cluster %q is not defined", id)
199 baseURL := remote.BaseURL()
200 target, err := baseURL.Parse(arvados.EndpointLogin.Path)
202 return arvados.LoginResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
204 params := url.Values{
205 "return_to": []string{options.ReturnTo},
207 if options.Remote != "" {
208 params.Set("remote", options.Remote)
210 target.RawQuery = params.Encode()
211 return arvados.LoginResponse{
212 RedirectLocation: target.String(),
215 return conn.local.Login(ctx, options)
218 func (conn *Conn) Logout(ctx context.Context, options arvados.LogoutOptions) (arvados.LogoutResponse, error) {
219 // If the logout request comes with an API token from a known
220 // remote cluster, redirect to that cluster's logout handler
221 // so it has an opportunity to clear sessions, expire tokens,
222 // etc. Otherwise use the local endpoint.
223 reqauth, ok := auth.FromContext(ctx)
224 if !ok || len(reqauth.Tokens) == 0 || len(reqauth.Tokens[0]) < 8 || !strings.HasPrefix(reqauth.Tokens[0], "v2/") {
225 return conn.local.Logout(ctx, options)
227 id := reqauth.Tokens[0][3:8]
228 if id == conn.cluster.ClusterID {
229 return conn.local.Logout(ctx, options)
231 remote, ok := conn.remotes[id]
233 return conn.local.Logout(ctx, options)
235 baseURL := remote.BaseURL()
236 target, err := baseURL.Parse(arvados.EndpointLogout.Path)
238 return arvados.LogoutResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
240 target.RawQuery = url.Values{"return_to": {options.ReturnTo}}.Encode()
241 return arvados.LogoutResponse{RedirectLocation: target.String()}, nil
244 func (conn *Conn) CollectionGet(ctx context.Context, options arvados.GetOptions) (arvados.Collection, error) {
245 if len(options.UUID) == 27 {
246 // UUID is really a UUID
247 c, err := conn.chooseBackend(options.UUID).CollectionGet(ctx, options)
248 if err == nil && options.UUID[:5] != conn.cluster.ClusterID {
249 c.ManifestText = rewriteManifest(c.ManifestText, options.UUID[:5])
254 first := make(chan arvados.Collection, 1)
255 err := conn.tryLocalThenRemotes(ctx, options.ForwardedFor, func(ctx context.Context, remoteID string, be backend) error {
256 remoteOpts := options
257 remoteOpts.ForwardedFor = conn.cluster.ClusterID + "-" + options.ForwardedFor
258 c, err := be.CollectionGet(ctx, remoteOpts)
262 // options.UUID is either hash+size or
263 // hash+size+hints; only hash+size need to
264 // match the computed PDH.
265 if pdh := arvados.PortableDataHash(c.ManifestText); pdh != options.UUID && !strings.HasPrefix(options.UUID, pdh+"+") {
266 err = httpErrorf(http.StatusBadGateway, "bad portable data hash %q received from remote %q (expected %q)", pdh, remoteID, options.UUID)
267 ctxlog.FromContext(ctx).Warn(err)
271 c.ManifestText = rewriteManifest(c.ManifestText, remoteID)
277 // lost race, return value doesn't matter
282 return arvados.Collection{}, err
287 func (conn *Conn) CollectionList(ctx context.Context, options arvados.ListOptions) (arvados.CollectionList, error) {
288 return conn.generated_CollectionList(ctx, options)
291 func (conn *Conn) CollectionProvenance(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
292 return conn.chooseBackend(options.UUID).CollectionProvenance(ctx, options)
295 func (conn *Conn) CollectionUsedBy(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
296 return conn.chooseBackend(options.UUID).CollectionUsedBy(ctx, options)
299 func (conn *Conn) CollectionDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
300 return conn.chooseBackend(options.UUID).CollectionDelete(ctx, options)
303 func (conn *Conn) CollectionTrash(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
304 return conn.chooseBackend(options.UUID).CollectionTrash(ctx, options)
307 func (conn *Conn) CollectionUntrash(ctx context.Context, options arvados.UntrashOptions) (arvados.Collection, error) {
308 return conn.chooseBackend(options.UUID).CollectionUntrash(ctx, options)
311 func (conn *Conn) ContainerList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerList, error) {
312 return conn.generated_ContainerList(ctx, options)
315 func (conn *Conn) ContainerCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Container, error) {
316 return conn.chooseBackend(options.ClusterID).ContainerCreate(ctx, options)
319 func (conn *Conn) ContainerUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Container, error) {
320 return conn.chooseBackend(options.UUID).ContainerUpdate(ctx, options)
323 func (conn *Conn) ContainerGet(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
324 return conn.chooseBackend(options.UUID).ContainerGet(ctx, options)
327 func (conn *Conn) ContainerDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Container, error) {
328 return conn.chooseBackend(options.UUID).ContainerDelete(ctx, options)
331 func (conn *Conn) ContainerLock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
332 return conn.chooseBackend(options.UUID).ContainerLock(ctx, options)
335 func (conn *Conn) ContainerUnlock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
336 return conn.chooseBackend(options.UUID).ContainerUnlock(ctx, options)
339 func (conn *Conn) ContainerSSH(ctx context.Context, options arvados.ContainerSSHOptions) (arvados.ContainerSSHConnection, error) {
340 return conn.chooseBackend(options.UUID).ContainerSSH(ctx, options)
343 func (conn *Conn) ContainerRequestList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerRequestList, error) {
344 return conn.generated_ContainerRequestList(ctx, options)
347 func (conn *Conn) ContainerRequestCreate(ctx context.Context, options arvados.CreateOptions) (arvados.ContainerRequest, error) {
348 be := conn.chooseBackend(options.ClusterID)
349 if be == conn.local {
350 return be.ContainerRequestCreate(ctx, options)
352 if _, ok := options.Attrs["runtime_token"]; !ok {
353 // If runtime_token is not set, create a new token
354 aca, err := conn.local.APIClientAuthorizationCurrent(ctx, arvados.GetOptions{})
356 // This should probably be StatusUnauthorized
357 // (need to update test in
358 // lib/controller/federation_test.go):
359 // When RoR is out of the picture this should be:
360 // return arvados.ContainerRequest{}, httpErrorf(http.StatusUnauthorized, "%w", err)
361 return arvados.ContainerRequest{}, httpErrorf(http.StatusForbidden, "%s", "invalid API token")
363 user, err := conn.local.UserGetCurrent(ctx, arvados.GetOptions{})
365 return arvados.ContainerRequest{}, err
367 if len(aca.Scopes) == 0 || aca.Scopes[0] != "all" {
368 return arvados.ContainerRequest{}, httpErrorf(http.StatusForbidden, "token scope is not [all]")
370 if strings.HasPrefix(aca.UUID, conn.cluster.ClusterID) {
371 // Local user, submitting to a remote cluster.
372 // Create a new time-limited token.
373 local, ok := conn.local.(*localdb.Conn)
375 return arvados.ContainerRequest{}, httpErrorf(http.StatusInternalServerError, "bug: local backend is a %T, not a *localdb.Conn", conn.local)
377 aca, err = local.CreateAPIClientAuthorization(ctx, conn.cluster.SystemRootToken, rpc.UserSessionAuthInfo{UserUUID: user.UUID,
378 ExpiresAt: time.Now().UTC().Add(conn.cluster.Collections.BlobSigningTTL.Duration())})
380 return arvados.ContainerRequest{}, err
382 options.Attrs["runtime_token"] = aca.TokenV2()
384 // Remote user. Container request will use the
385 // current token, minus the trailing portion
386 // (optional container uuid).
387 options.Attrs["runtime_token"] = aca.TokenV2()
390 return be.ContainerRequestCreate(ctx, options)
393 func (conn *Conn) ContainerRequestUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.ContainerRequest, error) {
394 return conn.chooseBackend(options.UUID).ContainerRequestUpdate(ctx, options)
397 func (conn *Conn) ContainerRequestGet(ctx context.Context, options arvados.GetOptions) (arvados.ContainerRequest, error) {
398 return conn.chooseBackend(options.UUID).ContainerRequestGet(ctx, options)
401 func (conn *Conn) ContainerRequestDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.ContainerRequest, error) {
402 return conn.chooseBackend(options.UUID).ContainerRequestDelete(ctx, options)
405 func (conn *Conn) SpecimenList(ctx context.Context, options arvados.ListOptions) (arvados.SpecimenList, error) {
406 return conn.generated_SpecimenList(ctx, options)
409 func (conn *Conn) SpecimenCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Specimen, error) {
410 return conn.chooseBackend(options.ClusterID).SpecimenCreate(ctx, options)
413 func (conn *Conn) SpecimenUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Specimen, error) {
414 return conn.chooseBackend(options.UUID).SpecimenUpdate(ctx, options)
417 func (conn *Conn) SpecimenGet(ctx context.Context, options arvados.GetOptions) (arvados.Specimen, error) {
418 return conn.chooseBackend(options.UUID).SpecimenGet(ctx, options)
421 func (conn *Conn) SpecimenDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Specimen, error) {
422 return conn.chooseBackend(options.UUID).SpecimenDelete(ctx, options)
425 var userAttrsCachedFromLoginCluster = map[string]bool{
438 "identity_url": false,
440 "modified_by_client_uuid": false,
441 "modified_by_user_uuid": false,
444 "writable_by": false,
447 func (conn *Conn) batchUpdateUsers(ctx context.Context,
448 options arvados.ListOptions,
449 items []arvados.User) (err error) {
451 id := conn.cluster.Login.LoginCluster
452 logger := ctxlog.FromContext(ctx)
453 batchOpts := arvados.UserBatchUpdateOptions{Updates: map[string]map[string]interface{}{}}
454 for _, user := range items {
455 if !strings.HasPrefix(user.UUID, id) {
458 logger.Debugf("cache user info for uuid %q", user.UUID)
460 // If the remote cluster has null timestamps
461 // (e.g., test server with incomplete
462 // fixtures) use dummy timestamps (instead of
463 // the zero time, which causes a Rails API
464 // error "year too big to marshal: 1 UTC").
465 if user.ModifiedAt.IsZero() {
466 user.ModifiedAt = time.Now()
468 if user.CreatedAt.IsZero() {
469 user.CreatedAt = time.Now()
472 var allFields map[string]interface{}
473 buf, err := json.Marshal(user)
475 return fmt.Errorf("error encoding user record from remote response: %s", err)
477 err = json.Unmarshal(buf, &allFields)
479 return fmt.Errorf("error transcoding user record from remote response: %s", err)
482 if len(options.Select) > 0 {
483 updates = map[string]interface{}{}
484 for _, k := range options.Select {
485 if v, ok := allFields[k]; ok && userAttrsCachedFromLoginCluster[k] {
490 for k := range updates {
491 if !userAttrsCachedFromLoginCluster[k] {
496 batchOpts.Updates[user.UUID] = updates
498 if len(batchOpts.Updates) > 0 {
499 ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{conn.cluster.SystemRootToken}})
500 _, err = conn.local.UserBatchUpdate(ctxRoot, batchOpts)
502 return fmt.Errorf("error updating local user records: %s", err)
508 func (conn *Conn) UserList(ctx context.Context, options arvados.ListOptions) (arvados.UserList, error) {
509 if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID && !options.BypassFederation {
510 resp, err := conn.chooseBackend(id).UserList(ctx, options)
514 err = conn.batchUpdateUsers(ctx, options, resp.Items)
516 return arvados.UserList{}, err
520 return conn.generated_UserList(ctx, options)
523 func (conn *Conn) UserCreate(ctx context.Context, options arvados.CreateOptions) (arvados.User, error) {
524 return conn.chooseBackend(options.ClusterID).UserCreate(ctx, options)
527 func (conn *Conn) UserUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.User, error) {
528 if options.BypassFederation {
529 return conn.local.UserUpdate(ctx, options)
531 resp, err := conn.chooseBackend(options.UUID).UserUpdate(ctx, options)
535 if !strings.HasPrefix(options.UUID, conn.cluster.ClusterID) {
536 // Copy the updated user record to the local cluster
537 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{}, []arvados.User{resp})
539 return arvados.User{}, err
545 func (conn *Conn) UserUpdateUUID(ctx context.Context, options arvados.UpdateUUIDOptions) (arvados.User, error) {
546 return conn.local.UserUpdateUUID(ctx, options)
549 func (conn *Conn) UserMerge(ctx context.Context, options arvados.UserMergeOptions) (arvados.User, error) {
550 return conn.local.UserMerge(ctx, options)
553 func (conn *Conn) UserActivate(ctx context.Context, options arvados.UserActivateOptions) (arvados.User, error) {
554 return conn.localOrLoginCluster().UserActivate(ctx, options)
557 func (conn *Conn) UserSetup(ctx context.Context, options arvados.UserSetupOptions) (map[string]interface{}, error) {
558 upstream := conn.localOrLoginCluster()
559 if upstream != conn.local {
560 // When LoginCluster is in effect, and we're setting
561 // up a remote user, and we want to give that user
562 // access to a local VM, we can't include the VM in
563 // the setup call, because the remote cluster won't
566 // Similarly, if we want to create a git repo,
567 // it should be created on the local cluster,
568 // not the remote one.
570 upstreamOptions := options
571 upstreamOptions.VMUUID = ""
572 upstreamOptions.RepoName = ""
574 ret, err := upstream.UserSetup(ctx, upstreamOptions)
580 return conn.local.UserSetup(ctx, options)
583 func (conn *Conn) UserUnsetup(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
584 return conn.localOrLoginCluster().UserUnsetup(ctx, options)
587 func (conn *Conn) UserGet(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
588 resp, err := conn.chooseBackend(options.UUID).UserGet(ctx, options)
592 if options.UUID != resp.UUID {
593 return arvados.User{}, httpErrorf(http.StatusBadGateway, "Had requested %v but response was for %v", options.UUID, resp.UUID)
595 if options.UUID[:5] != conn.cluster.ClusterID {
596 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{Select: options.Select}, []arvados.User{resp})
598 return arvados.User{}, err
604 func (conn *Conn) UserGetCurrent(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
605 return conn.local.UserGetCurrent(ctx, options)
608 func (conn *Conn) UserGetSystem(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
609 return conn.chooseBackend(options.UUID).UserGetSystem(ctx, options)
612 func (conn *Conn) UserDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.User, error) {
613 return conn.chooseBackend(options.UUID).UserDelete(ctx, options)
616 func (conn *Conn) UserBatchUpdate(ctx context.Context, options arvados.UserBatchUpdateOptions) (arvados.UserList, error) {
617 return conn.local.UserBatchUpdate(ctx, options)
620 func (conn *Conn) UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
621 return conn.local.UserAuthenticate(ctx, options)
624 func (conn *Conn) APIClientAuthorizationCurrent(ctx context.Context, options arvados.GetOptions) (arvados.APIClientAuthorization, error) {
625 return conn.chooseBackend(options.UUID).APIClientAuthorizationCurrent(ctx, options)
628 type backend interface {
633 type notFoundError struct{}
635 func (notFoundError) HTTPStatus() int { return http.StatusNotFound }
636 func (notFoundError) Error() string { return "not found" }
638 func errStatus(err error) int {
639 if httpErr, ok := err.(interface{ HTTPStatus() int }); ok {
640 return httpErr.HTTPStatus()
642 return http.StatusInternalServerError