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