lib/controller/federation/conn.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package federation
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "crypto/md5"
  11         "encoding/json"
  12         "errors"
  13         "fmt"
  14         "net/http"
  15         "net/url"
  16         "regexp"
  17         "strings"
  18         "time"
  19
  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"
  26 )
  27
  28 type Conn struct {
  29         cluster *arvados.Cluster
  30         local   backend
  31         remotes map[string]backend
  32 }
  33
  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 {
  39                         continue
  40                 }
  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
  43                 // to detect loops.
  44                 conn.SendHeader = http.Header{"Via": {"HTTP/1.1 arvados-controller"}}
  45                 remotes[id] = conn
  46         }
  47
  48         return &Conn{
  49                 cluster: cluster,
  50                 local:   local,
  51                 remotes: remotes,
  52         }
  53 }
  54
  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
  58 // resulting tokens.
  59 func saltedTokenProvider(local backend, remoteID string) rpc.TokenProvider {
  60         return func(ctx context.Context) ([]string, error) {
  61                 var tokens []string
  62                 incoming, ok := auth.FromContext(ctx)
  63                 if !ok {
  64                         return nil, errors.New("no token provided")
  65                 }
  66                 for _, token := range incoming.Tokens {
  67                         salted, err := auth.SaltToken(token, remoteID)
  68                         switch err {
  69                         case nil:
  70                                 tokens = append(tokens, salted)
  71                         case auth.ErrSalted:
  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)
  79                                         continue
  80                                 } else if err != nil {
  81                                         return nil, err
  82                                 }
  83                                 salted, err := auth.SaltToken(aca.TokenV2(), remoteID)
  84                                 if err != nil {
  85                                         return nil, err
  86                                 }
  87                                 tokens = append(tokens, salted)
  88                         default:
  89                                 return nil, err
  90                         }
  91                 }
  92                 return tokens, nil
  93         }
  94 }
  95
  96 // Return suitable backend for a query about the given cluster ID
  97 // ("aaaaa") or object UUID ("aaaaa-dz642-abcdefghijklmno").
  98 func (conn *Conn) chooseBackend(id string) backend {
  99         if len(id) == 27 {
 100                 id = id[:5]
 101         } else if len(id) != 5 {
 102                 // PDH or bogus ID
 103                 return conn.local
 104         }
 105         if id == conn.cluster.ClusterID {
 106                 return conn.local
 107         } else if be, ok := conn.remotes[id]; ok {
 108                 return be
 109         } else {
 110                 // TODO: return an "always error" backend?
 111                 return conn.local
 112         }
 113 }
 114
 115 // Call fn with the local backend; then, if fn returned 404, call fn
 116 // on the available remote backends (possibly concurrently) until one
 117 // succeeds.
 118 //
 119 // The second argument to fn is the cluster ID of the remote backend,
 120 // or "" for the local backend.
 121 //
 122 // A non-nil error means all backends failed.
 123 func (conn *Conn) tryLocalThenRemotes(ctx context.Context, forwardedFor string, fn func(context.Context, string, backend) error) error {
 124         if err := fn(ctx, "", conn.local); err == nil || errStatus(err) != http.StatusNotFound || forwardedFor != "" {
 125                 // Note: forwardedFor != "" means this request came
 126                 // from a remote cluster, so we don't take a second
 127                 // hop. This avoids cycles, redundant calls to a
 128                 // mutually reachable remote, and use of double-salted
 129                 // tokens.
 130                 return err
 131         }
 132
 133         ctx, cancel := context.WithCancel(ctx)
 134         defer cancel()
 135         errchan := make(chan error, len(conn.remotes))
 136         for remoteID, be := range conn.remotes {
 137                 remoteID, be := remoteID, be
 138                 go func() {
 139                         errchan <- fn(ctx, remoteID, be)
 140                 }()
 141         }
 142         all404 := true
 143         var errs []error
 144         for i := 0; i < cap(errchan); i++ {
 145                 err := <-errchan
 146                 if err == nil {
 147                         return nil
 148                 }
 149                 all404 = all404 && errStatus(err) == http.StatusNotFound
 150                 errs = append(errs, err)
 151         }
 152         if all404 {
 153                 return notFoundError{}
 154         }
 155         return httpErrorf(http.StatusBadGateway, "errors: %v", errs)
 156 }
 157
 158 func (conn *Conn) CollectionCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Collection, error) {
 159         return conn.chooseBackend(options.ClusterID).CollectionCreate(ctx, options)
 160 }
 161
 162 func (conn *Conn) CollectionUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Collection, error) {
 163         return conn.chooseBackend(options.UUID).CollectionUpdate(ctx, options)
 164 }
 165
 166 func rewriteManifest(mt, remoteID string) string {
 167         return regexp.MustCompile(` [0-9a-f]{32}\+[^ ]*`).ReplaceAllStringFunc(mt, func(tok string) string {
 168                 return strings.Replace(tok, "+A", "+R"+remoteID+"-", -1)
 169         })
 170 }
 171
 172 // this could be in sdk/go/arvados
 173 func portableDataHash(mt string) string {
 174         h := md5.New()
 175         blkRe := regexp.MustCompile(`^ [0-9a-f]{32}\+\d+`)
 176         size := 0
 177         _ = regexp.MustCompile(` ?[^ ]*`).ReplaceAllFunc([]byte(mt), func(tok []byte) []byte {
 178                 if m := blkRe.Find(tok); m != nil {
 179                         // write hash+size, ignore remaining block hints
 180                         tok = m
 181                 }
 182                 n, err := h.Write(tok)
 183                 if err != nil {
 184                         panic(err)
 185                 }
 186                 size += n
 187                 return nil
 188         })
 189         return fmt.Sprintf("%x+%d", h.Sum(nil), size)
 190 }
 191
 192 func (conn *Conn) ConfigGet(ctx context.Context) (json.RawMessage, error) {
 193         var buf bytes.Buffer
 194         err := config.ExportJSON(&buf, conn.cluster)
 195         return json.RawMessage(buf.Bytes()), err
 196 }
 197
 198 func (conn *Conn) Login(ctx context.Context, options arvados.LoginOptions) (arvados.LoginResponse, error) {
 199         if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID {
 200                 // defer entire login procedure to designated cluster
 201                 remote, ok := conn.remotes[id]
 202                 if !ok {
 203                         return arvados.LoginResponse{}, fmt.Errorf("configuration problem: designated login cluster %q is not defined", id)
 204                 }
 205                 baseURL := remote.BaseURL()
 206                 target, err := baseURL.Parse(arvados.EndpointLogin.Path)
 207                 if err != nil {
 208                         return arvados.LoginResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
 209                 }
 210                 params := url.Values{
 211                         "return_to": []string{options.ReturnTo},
 212                 }
 213                 if options.Remote != "" {
 214                         params.Set("remote", options.Remote)
 215                 }
 216                 target.RawQuery = params.Encode()
 217                 return arvados.LoginResponse{
 218                         RedirectLocation: target.String(),
 219                 }, nil
 220         } else {
 221                 return conn.local.Login(ctx, options)
 222         }
 223 }
 224
 225 func (conn *Conn) Logout(ctx context.Context, options arvados.LogoutOptions) (arvados.LogoutResponse, error) {
 226         // If the logout request comes with an API token from a known
 227         // remote cluster, redirect to that cluster's logout handler
 228         // so it has an opportunity to clear sessions, expire tokens,
 229         // etc. Otherwise use the local endpoint.
 230         reqauth, ok := auth.FromContext(ctx)
 231         if !ok || len(reqauth.Tokens) == 0 || len(reqauth.Tokens[0]) < 8 || !strings.HasPrefix(reqauth.Tokens[0], "v2/") {
 232                 return conn.local.Logout(ctx, options)
 233         }
 234         id := reqauth.Tokens[0][3:8]
 235         if id == conn.cluster.ClusterID {
 236                 return conn.local.Logout(ctx, options)
 237         }
 238         remote, ok := conn.remotes[id]
 239         if !ok {
 240                 return conn.local.Logout(ctx, options)
 241         }
 242         baseURL := remote.BaseURL()
 243         target, err := baseURL.Parse(arvados.EndpointLogout.Path)
 244         if err != nil {
 245                 return arvados.LogoutResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
 246         }
 247         target.RawQuery = url.Values{"return_to": {options.ReturnTo}}.Encode()
 248         return arvados.LogoutResponse{RedirectLocation: target.String()}, nil
 249 }
 250
 251 func (conn *Conn) CollectionGet(ctx context.Context, options arvados.GetOptions) (arvados.Collection, error) {
 252         if len(options.UUID) == 27 {
 253                 // UUID is really a UUID
 254                 c, err := conn.chooseBackend(options.UUID).CollectionGet(ctx, options)
 255                 if err == nil && options.UUID[:5] != conn.cluster.ClusterID {
 256                         c.ManifestText = rewriteManifest(c.ManifestText, options.UUID[:5])
 257                 }
 258                 return c, err
 259         } else {
 260                 // UUID is a PDH
 261                 first := make(chan arvados.Collection, 1)
 262                 err := conn.tryLocalThenRemotes(ctx, options.ForwardedFor, func(ctx context.Context, remoteID string, be backend) error {
 263                         remoteOpts := options
 264                         remoteOpts.ForwardedFor = conn.cluster.ClusterID + "-" + options.ForwardedFor
 265                         c, err := be.CollectionGet(ctx, remoteOpts)
 266                         if err != nil {
 267                                 return err
 268                         }
 269                         // options.UUID is either hash+size or
 270                         // hash+size+hints; only hash+size need to
 271                         // match the computed PDH.
 272                         if pdh := portableDataHash(c.ManifestText); pdh != options.UUID && !strings.HasPrefix(options.UUID, pdh+"+") {
 273                                 err = httpErrorf(http.StatusBadGateway, "bad portable data hash %q received from remote %q (expected %q)", pdh, remoteID, options.UUID)
 274                                 ctxlog.FromContext(ctx).Warn(err)
 275                                 return err
 276                         }
 277                         if remoteID != "" {
 278                                 c.ManifestText = rewriteManifest(c.ManifestText, remoteID)
 279                         }
 280                         select {
 281                         case first <- c:
 282                                 return nil
 283                         default:
 284                                 // lost race, return value doesn't matter
 285                                 return nil
 286                         }
 287                 })
 288                 if err != nil {
 289                         return arvados.Collection{}, err
 290                 }
 291                 return <-first, nil
 292         }
 293 }
 294
 295 func (conn *Conn) CollectionList(ctx context.Context, options arvados.ListOptions) (arvados.CollectionList, error) {
 296         return conn.generated_CollectionList(ctx, options)
 297 }
 298
 299 func (conn *Conn) CollectionProvenance(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
 300         return conn.chooseBackend(options.UUID).CollectionProvenance(ctx, options)
 301 }
 302
 303 func (conn *Conn) CollectionUsedBy(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
 304         return conn.chooseBackend(options.UUID).CollectionUsedBy(ctx, options)
 305 }
 306
 307 func (conn *Conn) CollectionDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
 308         return conn.chooseBackend(options.UUID).CollectionDelete(ctx, options)
 309 }
 310
 311 func (conn *Conn) CollectionTrash(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
 312         return conn.chooseBackend(options.UUID).CollectionTrash(ctx, options)
 313 }
 314
 315 func (conn *Conn) CollectionUntrash(ctx context.Context, options arvados.UntrashOptions) (arvados.Collection, error) {
 316         return conn.chooseBackend(options.UUID).CollectionUntrash(ctx, options)
 317 }
 318
 319 func (conn *Conn) ContainerList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerList, error) {
 320         return conn.generated_ContainerList(ctx, options)
 321 }
 322
 323 func (conn *Conn) ContainerCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Container, error) {
 324         return conn.chooseBackend(options.ClusterID).ContainerCreate(ctx, options)
 325 }
 326
 327 func (conn *Conn) ContainerUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Container, error) {
 328         return conn.chooseBackend(options.UUID).ContainerUpdate(ctx, options)
 329 }
 330
 331 func (conn *Conn) ContainerGet(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
 332         return conn.chooseBackend(options.UUID).ContainerGet(ctx, options)
 333 }
 334
 335 func (conn *Conn) ContainerDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Container, error) {
 336         return conn.chooseBackend(options.UUID).ContainerDelete(ctx, options)
 337 }
 338
 339 func (conn *Conn) ContainerLock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
 340         return conn.chooseBackend(options.UUID).ContainerLock(ctx, options)
 341 }
 342
 343 func (conn *Conn) ContainerUnlock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
 344         return conn.chooseBackend(options.UUID).ContainerUnlock(ctx, options)
 345 }
 346
 347 func (conn *Conn) SpecimenList(ctx context.Context, options arvados.ListOptions) (arvados.SpecimenList, error) {
 348         return conn.generated_SpecimenList(ctx, options)
 349 }
 350
 351 func (conn *Conn) SpecimenCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Specimen, error) {
 352         return conn.chooseBackend(options.ClusterID).SpecimenCreate(ctx, options)
 353 }
 354
 355 func (conn *Conn) SpecimenUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Specimen, error) {
 356         return conn.chooseBackend(options.UUID).SpecimenUpdate(ctx, options)
 357 }
 358
 359 func (conn *Conn) SpecimenGet(ctx context.Context, options arvados.GetOptions) (arvados.Specimen, error) {
 360         return conn.chooseBackend(options.UUID).SpecimenGet(ctx, options)
 361 }
 362
 363 func (conn *Conn) SpecimenDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Specimen, error) {
 364         return conn.chooseBackend(options.UUID).SpecimenDelete(ctx, options)
 365 }
 366
 367 var userAttrsCachedFromLoginCluster = map[string]bool{
 368         "created_at":  true,
 369         "email":       true,
 370         "first_name":  true,
 371         "is_active":   true,
 372         "is_admin":    true,
 373         "last_name":   true,
 374         "modified_at": true,
 375         "prefs":       true,
 376         "username":    true,
 377
 378         "etag":                    false,
 379         "full_name":               false,
 380         "identity_url":            false,
 381         "is_invited":              false,
 382         "modified_by_client_uuid": false,
 383         "modified_by_user_uuid":   false,
 384         "owner_uuid":              false,
 385         "uuid":                    false,
 386         "writable_by":             false,
 387 }
 388
 389 func (conn *Conn) UserList(ctx context.Context, options arvados.ListOptions) (arvados.UserList, error) {
 390         logger := ctxlog.FromContext(ctx)
 391         if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID {
 392                 resp, err := conn.chooseBackend(id).UserList(ctx, options)
 393                 if err != nil {
 394                         return resp, err
 395                 }
 396                 batchOpts := arvados.UserBatchUpdateOptions{Updates: map[string]map[string]interface{}{}}
 397                 for _, user := range resp.Items {
 398                         if !strings.HasPrefix(user.UUID, id) {
 399                                 continue
 400                         }
 401                         logger.Debugf("cache user info for uuid %q", user.UUID)
 402
 403                         // If the remote cluster has null timestamps
 404                         // (e.g., test server with incomplete
 405                         // fixtures) use dummy timestamps (instead of
 406                         // the zero time, which causes a Rails API
 407                         // error "year too big to marshal: 1 UTC").
 408                         if user.ModifiedAt.IsZero() {
 409                                 user.ModifiedAt = time.Now()
 410                         }
 411                         if user.CreatedAt.IsZero() {
 412                                 user.CreatedAt = time.Now()
 413                         }
 414
 415                         var allFields map[string]interface{}
 416                         buf, err := json.Marshal(user)
 417                         if err != nil {
 418                                 return arvados.UserList{}, fmt.Errorf("error encoding user record from remote response: %s", err)
 419                         }
 420                         err = json.Unmarshal(buf, &allFields)
 421                         if err != nil {
 422                                 return arvados.UserList{}, fmt.Errorf("error transcoding user record from remote response: %s", err)
 423                         }
 424                         updates := allFields
 425                         if len(options.Select) > 0 {
 426                                 updates = map[string]interface{}{}
 427                                 for _, k := range options.Select {
 428                                         if v, ok := allFields[k]; ok && userAttrsCachedFromLoginCluster[k] {
 429                                                 updates[k] = v
 430                                         }
 431                                 }
 432                         } else {
 433                                 for k := range updates {
 434                                         if !userAttrsCachedFromLoginCluster[k] {
 435                                                 delete(updates, k)
 436                                         }
 437                                 }
 438                         }
 439                         batchOpts.Updates[user.UUID] = updates
 440                 }
 441                 if len(batchOpts.Updates) > 0 {
 442                         ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{conn.cluster.SystemRootToken}})
 443                         _, err = conn.local.UserBatchUpdate(ctxRoot, batchOpts)
 444                         if err != nil {
 445                                 return arvados.UserList{}, fmt.Errorf("error updating local user records: %s", err)
 446                         }
 447                 }
 448                 return resp, nil
 449         } else {
 450                 return conn.generated_UserList(ctx, options)
 451         }
 452 }
 453
 454 func (conn *Conn) UserCreate(ctx context.Context, options arvados.CreateOptions) (arvados.User, error) {
 455         return conn.chooseBackend(options.ClusterID).UserCreate(ctx, options)
 456 }
 457
 458 func (conn *Conn) UserUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.User, error) {
 459         return conn.chooseBackend(options.UUID).UserUpdate(ctx, options)
 460 }
 461
 462 func (conn *Conn) UserUpdateUUID(ctx context.Context, options arvados.UpdateUUIDOptions) (arvados.User, error) {
 463         return conn.chooseBackend(options.UUID).UserUpdateUUID(ctx, options)
 464 }
 465
 466 func (conn *Conn) UserMerge(ctx context.Context, options arvados.UserMergeOptions) (arvados.User, error) {
 467         return conn.chooseBackend(options.OldUserUUID).UserMerge(ctx, options)
 468 }
 469
 470 func (conn *Conn) UserActivate(ctx context.Context, options arvados.UserActivateOptions) (arvados.User, error) {
 471         return conn.chooseBackend(options.UUID).UserActivate(ctx, options)
 472 }
 473
 474 func (conn *Conn) UserSetup(ctx context.Context, options arvados.UserSetupOptions) (map[string]interface{}, error) {
 475         return conn.chooseBackend(options.UUID).UserSetup(ctx, options)
 476 }
 477
 478 func (conn *Conn) UserUnsetup(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
 479         return conn.chooseBackend(options.UUID).UserUnsetup(ctx, options)
 480 }
 481
 482 func (conn *Conn) UserGet(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
 483         return conn.chooseBackend(options.UUID).UserGet(ctx, options)
 484 }
 485
 486 func (conn *Conn) UserGetCurrent(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
 487         return conn.chooseBackend(options.UUID).UserGetCurrent(ctx, options)
 488 }
 489
 490 func (conn *Conn) UserGetSystem(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
 491         return conn.chooseBackend(options.UUID).UserGetSystem(ctx, options)
 492 }
 493
 494 func (conn *Conn) UserDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.User, error) {
 495         return conn.chooseBackend(options.UUID).UserDelete(ctx, options)
 496 }
 497
 498 func (conn *Conn) UserBatchUpdate(ctx context.Context, options arvados.UserBatchUpdateOptions) (arvados.UserList, error) {
 499         return conn.local.UserBatchUpdate(ctx, options)
 500 }
 501
 502 func (conn *Conn) APIClientAuthorizationCurrent(ctx context.Context, options arvados.GetOptions) (arvados.APIClientAuthorization, error) {
 503         return conn.chooseBackend(options.UUID).APIClientAuthorizationCurrent(ctx, options)
 504 }
 505
 506 type backend interface {
 507         arvados.API
 508         BaseURL() url.URL
 509 }
 510
 511 type notFoundError struct{}
 512
 513 func (notFoundError) HTTPStatus() int { return http.StatusNotFound }
 514 func (notFoundError) Error() string   { return "not found" }
 515
 516 func errStatus(err error) int {
 517         if httpErr, ok := err.(interface{ HTTPStatus() int }); ok {
 518                 return httpErr.HTTPStatus()
 519         } else {
 520                 return http.StatusInternalServerError
 521         }
 522 }