17170: Return more helpful error if APIHost is not set.
[arvados.git] / 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         "encoding/json"
11         "errors"
12         "fmt"
13         "net/http"
14         "net/url"
15         "regexp"
16         "strings"
17         "time"
18
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"
25 )
26
27 type Conn struct {
28         cluster *arvados.Cluster
29         local   backend
30         remotes map[string]backend
31 }
32
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 {
38                         continue
39                 }
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
42                 // to detect loops.
43                 conn.SendHeader = http.Header{"Via": {"HTTP/1.1 arvados-controller"}}
44                 remotes[id] = conn
45         }
46
47         return &Conn{
48                 cluster: cluster,
49                 local:   local,
50                 remotes: remotes,
51         }
52 }
53
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
57 // resulting tokens.
58 func saltedTokenProvider(local backend, remoteID string) rpc.TokenProvider {
59         return func(ctx context.Context) ([]string, error) {
60                 var tokens []string
61                 incoming, ok := auth.FromContext(ctx)
62                 if !ok {
63                         return nil, errors.New("no token provided")
64                 }
65                 for _, token := range incoming.Tokens {
66                         salted, err := auth.SaltToken(token, remoteID)
67                         switch err {
68                         case nil:
69                                 tokens = append(tokens, salted)
70                         case auth.ErrSalted:
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)
78                                         continue
79                                 } else if err != nil {
80                                         return nil, err
81                                 }
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)
88                                         continue
89                                 }
90                                 salted, err := auth.SaltToken(aca.TokenV2(), remoteID)
91                                 if err != nil {
92                                         return nil, err
93                                 }
94                                 tokens = append(tokens, salted)
95                         default:
96                                 return nil, err
97                         }
98                 }
99                 return tokens, nil
100         }
101 }
102
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 {
106         if len(id) == 27 {
107                 id = id[:5]
108         } else if len(id) != 5 {
109                 // PDH or bogus ID
110                 return conn.local
111         }
112         if id == conn.cluster.ClusterID {
113                 return conn.local
114         } else if be, ok := conn.remotes[id]; ok {
115                 return be
116         } else {
117                 // TODO: return an "always error" backend?
118                 return conn.local
119         }
120 }
121
122 func (conn *Conn) localOrLoginCluster() backend {
123         if conn.cluster.Login.LoginCluster != "" {
124                 return conn.chooseBackend(conn.cluster.Login.LoginCluster)
125         }
126         return conn.local
127 }
128
129 // Call fn with the local backend; then, if fn returned 404, call fn
130 // on the available remote backends (possibly concurrently) until one
131 // succeeds.
132 //
133 // The second argument to fn is the cluster ID of the remote backend,
134 // or "" for the local backend.
135 //
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
143                 // tokens.
144                 return err
145         }
146
147         ctx, cancel := context.WithCancel(ctx)
148         defer cancel()
149         errchan := make(chan error, len(conn.remotes))
150         for remoteID, be := range conn.remotes {
151                 remoteID, be := remoteID, be
152                 go func() {
153                         errchan <- fn(ctx, remoteID, be)
154                 }()
155         }
156         all404 := true
157         var errs []error
158         for i := 0; i < cap(errchan); i++ {
159                 err := <-errchan
160                 if err == nil {
161                         return nil
162                 }
163                 all404 = all404 && errStatus(err) == http.StatusNotFound
164                 errs = append(errs, err)
165         }
166         if all404 {
167                 return notFoundError{}
168         }
169         return httpErrorf(http.StatusBadGateway, "errors: %v", errs)
170 }
171
172 func (conn *Conn) CollectionCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Collection, error) {
173         return conn.chooseBackend(options.ClusterID).CollectionCreate(ctx, options)
174 }
175
176 func (conn *Conn) CollectionUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Collection, error) {
177         return conn.chooseBackend(options.UUID).CollectionUpdate(ctx, options)
178 }
179
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)
183         })
184 }
185
186 func (conn *Conn) ConfigGet(ctx context.Context) (json.RawMessage, error) {
187         var buf bytes.Buffer
188         err := config.ExportJSON(&buf, conn.cluster)
189         return json.RawMessage(buf.Bytes()), err
190 }
191
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]
196                 if !ok {
197                         return arvados.LoginResponse{}, fmt.Errorf("configuration problem: designated login cluster %q is not defined", id)
198                 }
199                 baseURL := remote.BaseURL()
200                 target, err := baseURL.Parse(arvados.EndpointLogin.Path)
201                 if err != nil {
202                         return arvados.LoginResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
203                 }
204                 params := url.Values{
205                         "return_to": []string{options.ReturnTo},
206                 }
207                 if options.Remote != "" {
208                         params.Set("remote", options.Remote)
209                 }
210                 target.RawQuery = params.Encode()
211                 return arvados.LoginResponse{
212                         RedirectLocation: target.String(),
213                 }, nil
214         }
215         return conn.local.Login(ctx, options)
216 }
217
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)
226         }
227         id := reqauth.Tokens[0][3:8]
228         if id == conn.cluster.ClusterID {
229                 return conn.local.Logout(ctx, options)
230         }
231         remote, ok := conn.remotes[id]
232         if !ok {
233                 return conn.local.Logout(ctx, options)
234         }
235         baseURL := remote.BaseURL()
236         target, err := baseURL.Parse(arvados.EndpointLogout.Path)
237         if err != nil {
238                 return arvados.LogoutResponse{}, fmt.Errorf("internal error getting redirect target: %s", err)
239         }
240         target.RawQuery = url.Values{"return_to": {options.ReturnTo}}.Encode()
241         return arvados.LogoutResponse{RedirectLocation: target.String()}, nil
242 }
243
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])
250                 }
251                 return c, err
252         }
253         // UUID is a PDH
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)
259                 if err != nil {
260                         return err
261                 }
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)
268                         return err
269                 }
270                 if remoteID != "" {
271                         c.ManifestText = rewriteManifest(c.ManifestText, remoteID)
272                 }
273                 select {
274                 case first <- c:
275                         return nil
276                 default:
277                         // lost race, return value doesn't matter
278                         return nil
279                 }
280         })
281         if err != nil {
282                 return arvados.Collection{}, err
283         }
284         return <-first, nil
285 }
286
287 func (conn *Conn) CollectionList(ctx context.Context, options arvados.ListOptions) (arvados.CollectionList, error) {
288         return conn.generated_CollectionList(ctx, options)
289 }
290
291 func (conn *Conn) CollectionProvenance(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
292         return conn.chooseBackend(options.UUID).CollectionProvenance(ctx, options)
293 }
294
295 func (conn *Conn) CollectionUsedBy(ctx context.Context, options arvados.GetOptions) (map[string]interface{}, error) {
296         return conn.chooseBackend(options.UUID).CollectionUsedBy(ctx, options)
297 }
298
299 func (conn *Conn) CollectionDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
300         return conn.chooseBackend(options.UUID).CollectionDelete(ctx, options)
301 }
302
303 func (conn *Conn) CollectionTrash(ctx context.Context, options arvados.DeleteOptions) (arvados.Collection, error) {
304         return conn.chooseBackend(options.UUID).CollectionTrash(ctx, options)
305 }
306
307 func (conn *Conn) CollectionUntrash(ctx context.Context, options arvados.UntrashOptions) (arvados.Collection, error) {
308         return conn.chooseBackend(options.UUID).CollectionUntrash(ctx, options)
309 }
310
311 func (conn *Conn) ContainerList(ctx context.Context, options arvados.ListOptions) (arvados.ContainerList, error) {
312         return conn.generated_ContainerList(ctx, options)
313 }
314
315 func (conn *Conn) ContainerCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Container, error) {
316         return conn.chooseBackend(options.ClusterID).ContainerCreate(ctx, options)
317 }
318
319 func (conn *Conn) ContainerUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Container, error) {
320         return conn.chooseBackend(options.UUID).ContainerUpdate(ctx, options)
321 }
322
323 func (conn *Conn) ContainerGet(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
324         return conn.chooseBackend(options.UUID).ContainerGet(ctx, options)
325 }
326
327 func (conn *Conn) ContainerDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Container, error) {
328         return conn.chooseBackend(options.UUID).ContainerDelete(ctx, options)
329 }
330
331 func (conn *Conn) ContainerLock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
332         return conn.chooseBackend(options.UUID).ContainerLock(ctx, options)
333 }
334
335 func (conn *Conn) ContainerUnlock(ctx context.Context, options arvados.GetOptions) (arvados.Container, error) {
336         return conn.chooseBackend(options.UUID).ContainerUnlock(ctx, options)
337 }
338
339 func (conn *Conn) ContainerSSH(ctx context.Context, options arvados.ContainerSSHOptions) (arvados.ContainerSSHConnection, error) {
340         return conn.chooseBackend(options.UUID).ContainerSSH(ctx, options)
341 }
342
343 func (conn *Conn) SpecimenList(ctx context.Context, options arvados.ListOptions) (arvados.SpecimenList, error) {
344         return conn.generated_SpecimenList(ctx, options)
345 }
346
347 func (conn *Conn) SpecimenCreate(ctx context.Context, options arvados.CreateOptions) (arvados.Specimen, error) {
348         return conn.chooseBackend(options.ClusterID).SpecimenCreate(ctx, options)
349 }
350
351 func (conn *Conn) SpecimenUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.Specimen, error) {
352         return conn.chooseBackend(options.UUID).SpecimenUpdate(ctx, options)
353 }
354
355 func (conn *Conn) SpecimenGet(ctx context.Context, options arvados.GetOptions) (arvados.Specimen, error) {
356         return conn.chooseBackend(options.UUID).SpecimenGet(ctx, options)
357 }
358
359 func (conn *Conn) SpecimenDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.Specimen, error) {
360         return conn.chooseBackend(options.UUID).SpecimenDelete(ctx, options)
361 }
362
363 var userAttrsCachedFromLoginCluster = map[string]bool{
364         "created_at":  true,
365         "email":       true,
366         "first_name":  true,
367         "is_active":   true,
368         "is_admin":    true,
369         "last_name":   true,
370         "modified_at": true,
371         "prefs":       true,
372         "username":    true,
373
374         "etag":                    false,
375         "full_name":               false,
376         "identity_url":            false,
377         "is_invited":              false,
378         "modified_by_client_uuid": false,
379         "modified_by_user_uuid":   false,
380         "owner_uuid":              false,
381         "uuid":                    false,
382         "writable_by":             false,
383 }
384
385 func (conn *Conn) batchUpdateUsers(ctx context.Context,
386         options arvados.ListOptions,
387         items []arvados.User) (err error) {
388
389         id := conn.cluster.Login.LoginCluster
390         logger := ctxlog.FromContext(ctx)
391         batchOpts := arvados.UserBatchUpdateOptions{Updates: map[string]map[string]interface{}{}}
392         for _, user := range items {
393                 if !strings.HasPrefix(user.UUID, id) {
394                         continue
395                 }
396                 logger.Debugf("cache user info for uuid %q", user.UUID)
397
398                 // If the remote cluster has null timestamps
399                 // (e.g., test server with incomplete
400                 // fixtures) use dummy timestamps (instead of
401                 // the zero time, which causes a Rails API
402                 // error "year too big to marshal: 1 UTC").
403                 if user.ModifiedAt.IsZero() {
404                         user.ModifiedAt = time.Now()
405                 }
406                 if user.CreatedAt.IsZero() {
407                         user.CreatedAt = time.Now()
408                 }
409
410                 var allFields map[string]interface{}
411                 buf, err := json.Marshal(user)
412                 if err != nil {
413                         return fmt.Errorf("error encoding user record from remote response: %s", err)
414                 }
415                 err = json.Unmarshal(buf, &allFields)
416                 if err != nil {
417                         return fmt.Errorf("error transcoding user record from remote response: %s", err)
418                 }
419                 updates := allFields
420                 if len(options.Select) > 0 {
421                         updates = map[string]interface{}{}
422                         for _, k := range options.Select {
423                                 if v, ok := allFields[k]; ok && userAttrsCachedFromLoginCluster[k] {
424                                         updates[k] = v
425                                 }
426                         }
427                 } else {
428                         for k := range updates {
429                                 if !userAttrsCachedFromLoginCluster[k] {
430                                         delete(updates, k)
431                                 }
432                         }
433                 }
434                 batchOpts.Updates[user.UUID] = updates
435         }
436         if len(batchOpts.Updates) > 0 {
437                 ctxRoot := auth.NewContext(ctx, &auth.Credentials{Tokens: []string{conn.cluster.SystemRootToken}})
438                 _, err = conn.local.UserBatchUpdate(ctxRoot, batchOpts)
439                 if err != nil {
440                         return fmt.Errorf("error updating local user records: %s", err)
441                 }
442         }
443         return nil
444 }
445
446 func (conn *Conn) UserList(ctx context.Context, options arvados.ListOptions) (arvados.UserList, error) {
447         if id := conn.cluster.Login.LoginCluster; id != "" && id != conn.cluster.ClusterID && !options.BypassFederation {
448                 resp, err := conn.chooseBackend(id).UserList(ctx, options)
449                 if err != nil {
450                         return resp, err
451                 }
452                 err = conn.batchUpdateUsers(ctx, options, resp.Items)
453                 if err != nil {
454                         return arvados.UserList{}, err
455                 }
456                 return resp, nil
457         }
458         return conn.generated_UserList(ctx, options)
459 }
460
461 func (conn *Conn) UserCreate(ctx context.Context, options arvados.CreateOptions) (arvados.User, error) {
462         return conn.chooseBackend(options.ClusterID).UserCreate(ctx, options)
463 }
464
465 func (conn *Conn) UserUpdate(ctx context.Context, options arvados.UpdateOptions) (arvados.User, error) {
466         if options.BypassFederation {
467                 return conn.local.UserUpdate(ctx, options)
468         }
469         resp, err := conn.chooseBackend(options.UUID).UserUpdate(ctx, options)
470         if err != nil {
471                 return resp, err
472         }
473         if !strings.HasPrefix(options.UUID, conn.cluster.ClusterID) {
474                 // Copy the updated user record to the local cluster
475                 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{}, []arvados.User{resp})
476                 if err != nil {
477                         return arvados.User{}, err
478                 }
479         }
480         return resp, err
481 }
482
483 func (conn *Conn) UserUpdateUUID(ctx context.Context, options arvados.UpdateUUIDOptions) (arvados.User, error) {
484         return conn.local.UserUpdateUUID(ctx, options)
485 }
486
487 func (conn *Conn) UserMerge(ctx context.Context, options arvados.UserMergeOptions) (arvados.User, error) {
488         return conn.local.UserMerge(ctx, options)
489 }
490
491 func (conn *Conn) UserActivate(ctx context.Context, options arvados.UserActivateOptions) (arvados.User, error) {
492         return conn.localOrLoginCluster().UserActivate(ctx, options)
493 }
494
495 func (conn *Conn) UserSetup(ctx context.Context, options arvados.UserSetupOptions) (map[string]interface{}, error) {
496         upstream := conn.localOrLoginCluster()
497         if upstream != conn.local {
498                 // When LoginCluster is in effect, and we're setting
499                 // up a remote user, and we want to give that user
500                 // access to a local VM, we can't include the VM in
501                 // the setup call, because the remote cluster won't
502                 // recognize it.
503
504                 // Similarly, if we want to create a git repo,
505                 // it should be created on the local cluster,
506                 // not the remote one.
507
508                 upstreamOptions := options
509                 upstreamOptions.VMUUID = ""
510                 upstreamOptions.RepoName = ""
511
512                 ret, err := upstream.UserSetup(ctx, upstreamOptions)
513                 if err != nil {
514                         return ret, err
515                 }
516         }
517
518         return conn.local.UserSetup(ctx, options)
519 }
520
521 func (conn *Conn) UserUnsetup(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
522         return conn.localOrLoginCluster().UserUnsetup(ctx, options)
523 }
524
525 func (conn *Conn) UserGet(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
526         resp, err := conn.chooseBackend(options.UUID).UserGet(ctx, options)
527         if err != nil {
528                 return resp, err
529         }
530         if options.UUID != resp.UUID {
531                 return arvados.User{}, httpErrorf(http.StatusBadGateway, "Had requested %v but response was for %v", options.UUID, resp.UUID)
532         }
533         if options.UUID[:5] != conn.cluster.ClusterID {
534                 err = conn.batchUpdateUsers(ctx, arvados.ListOptions{Select: options.Select}, []arvados.User{resp})
535                 if err != nil {
536                         return arvados.User{}, err
537                 }
538         }
539         return resp, nil
540 }
541
542 func (conn *Conn) UserGetCurrent(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
543         return conn.local.UserGetCurrent(ctx, options)
544 }
545
546 func (conn *Conn) UserGetSystem(ctx context.Context, options arvados.GetOptions) (arvados.User, error) {
547         return conn.chooseBackend(options.UUID).UserGetSystem(ctx, options)
548 }
549
550 func (conn *Conn) UserDelete(ctx context.Context, options arvados.DeleteOptions) (arvados.User, error) {
551         return conn.chooseBackend(options.UUID).UserDelete(ctx, options)
552 }
553
554 func (conn *Conn) UserBatchUpdate(ctx context.Context, options arvados.UserBatchUpdateOptions) (arvados.UserList, error) {
555         return conn.local.UserBatchUpdate(ctx, options)
556 }
557
558 func (conn *Conn) UserAuthenticate(ctx context.Context, options arvados.UserAuthenticateOptions) (arvados.APIClientAuthorization, error) {
559         return conn.local.UserAuthenticate(ctx, options)
560 }
561
562 func (conn *Conn) APIClientAuthorizationCurrent(ctx context.Context, options arvados.GetOptions) (arvados.APIClientAuthorization, error) {
563         return conn.chooseBackend(options.UUID).APIClientAuthorizationCurrent(ctx, options)
564 }
565
566 type backend interface {
567         arvados.API
568         BaseURL() url.URL
569 }
570
571 type notFoundError struct{}
572
573 func (notFoundError) HTTPStatus() int { return http.StatusNotFound }
574 func (notFoundError) Error() string   { return "not found" }
575
576 func errStatus(err error) int {
577         if httpErr, ok := err.(interface{ HTTPStatus() int }); ok {
578                 return httpErr.HTTPStatus()
579         }
580         return http.StatusInternalServerError
581 }