1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
21 "git.curoverse.com/arvados.git/sdk/go/arvados"
22 "git.curoverse.com/arvados.git/sdk/go/auth"
23 "git.curoverse.com/arvados.git/sdk/go/httpserver"
24 "git.curoverse.com/arvados.git/sdk/go/keepclient"
27 var wfRe = regexp.MustCompile(`^/arvados/v1/workflows/([0-9a-z]{5})-[^/]+$`)
28 var collectionRe = regexp.MustCompile(`^/arvados/v1/collections/([0-9a-z]{5})-[^/]+$`)
29 var collectionByPDHRe = regexp.MustCompile(`^/arvados/v1/collections/([0-9a-fA-F]{32}\+[0-9]+)+$`)
31 type genericFederatedRequestHandler struct {
36 type collectionFederatedRequestHandler struct {
41 func (h *Handler) remoteClusterRequest(remoteID string, w http.ResponseWriter, req *http.Request, filter ResponseFilter) {
42 remote, ok := h.Cluster.RemoteClusters[remoteID]
44 httpserver.Error(w, "no proxy available for cluster "+remoteID, http.StatusNotFound)
47 scheme := remote.Scheme
51 err := h.saltAuthToken(req, remoteID)
53 httpserver.Error(w, err.Error(), http.StatusBadRequest)
60 RawPath: req.URL.RawPath,
61 RawQuery: req.URL.RawQuery,
63 client := h.secureClient
65 client = h.insecureClient
67 h.proxy.Do(w, req, urlOut, client, filter)
70 func (h *genericFederatedRequestHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
71 m := wfRe.FindStringSubmatch(req.URL.Path)
72 if len(m) < 2 || m[1] == h.handler.Cluster.ClusterID {
73 h.next.ServeHTTP(w, req)
76 h.handler.remoteClusterRequest(m[1], w, req, nil)
79 type rewriteSignaturesClusterId string
81 func (clusterId rewriteSignaturesClusterId) rewriteSignatures(resp *http.Response, requestError error) (newResponse *http.Response, err error) {
82 if requestError != nil {
83 return resp, requestError
86 if resp.StatusCode != 200 {
90 originalBody := resp.Body
91 defer originalBody.Close()
93 var col arvados.Collection
94 err = json.NewDecoder(resp.Body).Decode(&col)
99 // rewriting signatures will make manifest text 5-10% bigger so calculate
100 // capacity accordingly
101 updatedManifest := bytes.NewBuffer(make([]byte, 0, int(float64(len(col.ManifestText))*1.1)))
103 scanner := bufio.NewScanner(strings.NewReader(col.ManifestText))
104 scanner.Buffer(make([]byte, 1048576), len(col.ManifestText))
106 line := scanner.Text()
107 tokens := strings.Split(line, " ")
109 return nil, fmt.Errorf("Invalid stream (<3 tokens): %q", line)
112 updatedManifest.WriteString(tokens[0])
113 for _, token := range tokens[1:] {
114 updatedManifest.WriteString(" ")
115 m := keepclient.SignedLocatorRe.FindStringSubmatch(token)
117 // Rewrite the block signature to be a remote signature
118 fmt.Fprintf(updatedManifest, "%s%s%s+R%s-%s%s", m[1], m[2], m[3], clusterId, m[5][2:], m[8])
120 updatedManifest.WriteString(token)
124 updatedManifest.WriteString("\n")
127 col.ManifestText = updatedManifest.String()
129 newbody, err := json.Marshal(col)
134 buf := bytes.NewBuffer(newbody)
135 resp.Body = ioutil.NopCloser(buf)
136 resp.ContentLength = int64(buf.Len())
137 resp.Header.Set("Content-Length", fmt.Sprintf("%v", buf.Len()))
142 type searchLocalClusterForPDH struct {
146 func (s *searchLocalClusterForPDH) filterLocalClusterResponse(resp *http.Response, requestError error) (newResponse *http.Response, err error) {
147 if requestError != nil {
148 return resp, requestError
151 if resp.StatusCode == 404 {
152 // Suppress returning this result, because we want to
153 // search the federation.
154 s.sentResponse = false
157 s.sentResponse = true
161 type searchRemoteClusterForPDH struct {
165 sharedContext *context.Context
171 func (s *searchRemoteClusterForPDH) filterRemoteClusterResponse(resp *http.Response, requestError error) (newResponse *http.Response, err error) {
176 // Another request already returned a response
180 if requestError != nil {
181 *s.errors = append(*s.errors, fmt.Sprintf("Request error contacting %q: %v", s.remoteID, requestError))
182 // Record the error and suppress response
186 if resp.StatusCode != 200 {
187 // Suppress returning unsuccessful result. Maybe
188 // another request will find it.
189 // TODO collect and return error responses.
190 *s.errors = append(*s.errors, fmt.Sprintf("Response from %q: %v", s.remoteID, resp.Status))
191 if resp.StatusCode == 404 && (*s.statusCode == 0 || *s.statusCode == 404) {
192 // Only return 404 if every response is 404
193 *s.statusCode = http.StatusNotFound
195 // Got a non-404 error response, convert into BadGateway
196 *s.statusCode = http.StatusBadGateway
203 // This reads the response body. We don't want to hold the
204 // lock while doing this because other remote requests could
205 // also have made it to this point, and we want don't want a
206 // slow response holding the lock to block a faster response
207 // that is waiting on the lock.
208 newResponse, err = rewriteSignaturesClusterId(s.remoteID).rewriteSignatures(resp, nil)
213 // Another request already returned a response
218 // Suppress returning unsuccessful result. Maybe
219 // another request will be successful.
220 *s.errors = append(*s.errors, fmt.Sprintf("Error parsing response from %q: %v", s.remoteID, err))
224 // We have a successful response. Suppress/cancel all the
225 // other requests/responses.
226 *s.sentResponse = true
229 return newResponse, nil
232 func (h *collectionFederatedRequestHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
233 m := collectionByPDHRe.FindStringSubmatch(req.URL.Path)
235 bearer := req.Header.Get("Authorization")
236 if len(h.handler.Cluster.RemoteClusters) == 0 ||
237 (strings.HasPrefix(bearer, "Bearer v2/") &&
239 bearer[10:15] != h.handler.Cluster.ClusterID) {
240 // Either there are no remote clusters to
241 // bother searching, or we got a salted token
242 // from another cluster (and it's not our job
243 // to perform searches for users from other
244 // clusters), so just continue down the
246 h.next.ServeHTTP(w, req)
250 // First, query the local cluster.
251 urlOut, insecure, err := findRailsAPI(h.handler.Cluster, h.handler.NodeProfile)
253 httpserver.Error(w, err.Error(), http.StatusInternalServerError)
258 Scheme: urlOut.Scheme,
261 RawPath: req.URL.RawPath,
262 RawQuery: req.URL.RawQuery,
264 client := h.handler.secureClient
266 client = h.handler.insecureClient
268 sf := &searchLocalClusterForPDH{}
269 h.handler.proxy.Do(w, req, urlOut, client, sf.filterLocalClusterResponse)
274 sharedContext, cancelFunc := context.WithCancel(req.Context())
276 req = req.WithContext(sharedContext)
278 // Create a goroutine for each cluster in the
279 // RemoteClusters map. The first valid result gets
280 // returned to the client. When that happens, all
281 // other outstanding requests are cancelled or
283 sentResponse := false
285 wg := sync.WaitGroup{}
287 var errorCode int = 0
288 for remoteID := range h.handler.Cluster.RemoteClusters {
289 search := &searchRemoteClusterForPDH{remoteID, &mtx, &sentResponse,
290 &sharedContext, cancelFunc, &errors, &errorCode}
293 h.handler.remoteClusterRequest(search.remoteID, w, req, search.filterRemoteClusterResponse)
303 // If all connections failed/timed out on all
304 // remote clusters, no status code could have
305 // been returned, so make sure to set one.
306 errorCode = http.StatusBadGateway
309 // No successful responses, so return the error
310 httpserver.Errors(w, errors, errorCode)
314 m = collectionRe.FindStringSubmatch(req.URL.Path)
315 if len(m) < 2 || m[1] == h.handler.Cluster.ClusterID {
316 h.next.ServeHTTP(w, req)
319 h.handler.remoteClusterRequest(m[1], w, req,
320 rewriteSignaturesClusterId(m[1]).rewriteSignatures)
323 func (h *Handler) setupProxyRemoteCluster(next http.Handler) http.Handler {
324 mux := http.NewServeMux()
325 mux.Handle("/arvados/v1/workflows", next)
326 mux.Handle("/arvados/v1/workflows/", &genericFederatedRequestHandler{next, h})
327 mux.Handle("/arvados/v1/collections", next)
328 mux.Handle("/arvados/v1/collections/", &collectionFederatedRequestHandler{next, h})
329 mux.Handle("/", next)
334 type CurrentUser struct {
335 Authorization arvados.APIClientAuthorization
339 func (h *Handler) validateAPItoken(req *http.Request, user *CurrentUser) error {
344 return db.QueryRowContext(req.Context(), `SELECT api_client_authorizations.uuid, users.uuid FROM api_client_authorizations JOIN users on api_client_authorizations.user_id=users.id WHERE api_token=$1 AND (expires_at IS NULL OR expires_at > current_timestamp) LIMIT 1`, user.Authorization.APIToken).Scan(&user.Authorization.UUID, &user.UUID)
347 // Extract the auth token supplied in req, and replace it with a
348 // salted token for the remote cluster.
349 func (h *Handler) saltAuthToken(req *http.Request, remote string) error {
350 creds := auth.NewCredentials()
351 creds.LoadTokensFromHTTPRequest(req)
352 if len(creds.Tokens) == 0 && req.Header.Get("Content-Type") == "application/x-www-form-encoded" {
353 // Override ParseForm's 10MiB limit by ensuring
354 // req.Body is a *http.maxBytesReader.
355 req.Body = http.MaxBytesReader(nil, req.Body, 1<<28) // 256MiB. TODO: use MaxRequestSize from discovery doc or config.
356 if err := creds.LoadTokensFromHTTPRequestBody(req); err != nil {
359 // Replace req.Body with a buffer that re-encodes the
360 // form without api_token, in case we end up
361 // forwarding the request.
362 if req.PostForm != nil {
363 req.PostForm.Del("api_token")
365 req.Body = ioutil.NopCloser(bytes.NewBufferString(req.PostForm.Encode()))
367 if len(creds.Tokens) == 0 {
370 token, err := auth.SaltToken(creds.Tokens[0], remote)
371 if err == auth.ErrObsoleteToken {
372 // If the token exists in our own database, salt it
373 // for the remote. Otherwise, assume it was issued by
374 // the remote, and pass it through unmodified.
375 currentUser := CurrentUser{Authorization: arvados.APIClientAuthorization{APIToken: creds.Tokens[0]}}
376 err = h.validateAPItoken(req, ¤tUser)
377 if err == sql.ErrNoRows {
378 // Not ours; pass through unmodified.
379 token = currentUser.Authorization.APIToken
380 } else if err != nil {
383 // Found; make V2 version and salt it.
384 token, err = auth.SaltToken(currentUser.Authorization.TokenV2(), remote)
389 } else if err != nil {
392 req.Header.Set("Authorization", "Bearer "+token)
394 // Remove api_token=... from the the query string, in case we
395 // end up forwarding the request.
396 if values, err := url.ParseQuery(req.URL.RawQuery); err != nil {
398 } else if _, ok := values["api_token"]; ok {
399 delete(values, "api_token")
400 req.URL.RawQuery = values.Encode()