lib/controller/router/router.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package router
   6
   7 import (
   8         "context"
   9         "fmt"
  10         "math"
  11         "net/http"
  12         "strings"
  13
  14         "git.arvados.org/arvados.git/lib/controller/api"
  15         "git.arvados.org/arvados.git/sdk/go/arvados"
  16         "git.arvados.org/arvados.git/sdk/go/auth"
  17         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  18         "git.arvados.org/arvados.git/sdk/go/httpserver"
  19         "github.com/gorilla/mux"
  20         "github.com/sirupsen/logrus"
  21 )
  22
  23 type router struct {
  24         mux     *mux.Router
  25         backend arvados.API
  26         config  Config
  27 }
  28
  29 type Config struct {
  30         // Return an error if request body exceeds this size. 0 means
  31         // unlimited.
  32         MaxRequestSize int
  33
  34         // If wrapCalls is not nil, it is called once for each API
  35         // method, and the returned method is used in its place. This
  36         // can be used to install hooks before and after each API call
  37         // and alter responses; see localdb.WrapCallsInTransaction for
  38         // an example.
  39         WrapCalls func(api.RoutableFunc) api.RoutableFunc
  40 }
  41
  42 // New returns a new router (which implements the http.Handler
  43 // interface) that serves requests by calling Arvados API methods on
  44 // the given backend.
  45 func New(backend arvados.API, config Config) *router {
  46         rtr := &router{
  47                 mux:     mux.NewRouter(),
  48                 backend: backend,
  49                 config:  config,
  50         }
  51         rtr.addRoutes()
  52         return rtr
  53 }
  54
  55 func (rtr *router) addRoutes() {
  56         for _, route := range []struct {
  57                 endpoint    arvados.APIEndpoint
  58                 defaultOpts func() interface{}
  59                 exec        api.RoutableFunc
  60         }{
  61                 {
  62                         arvados.EndpointConfigGet,
  63                         func() interface{} { return &struct{}{} },
  64                         func(ctx context.Context, opts interface{}) (interface{}, error) {
  65                                 return rtr.backend.ConfigGet(ctx)
  66                         },
  67                 },
  68                 {
  69                         arvados.EndpointVocabularyGet,
  70                         func() interface{} { return &struct{}{} },
  71                         func(ctx context.Context, opts interface{}) (interface{}, error) {
  72                                 return rtr.backend.VocabularyGet(ctx)
  73                         },
  74                 },
  75                 {
  76                         arvados.EndpointLogin,
  77                         func() interface{} { return &arvados.LoginOptions{} },
  78                         func(ctx context.Context, opts interface{}) (interface{}, error) {
  79                                 return rtr.backend.Login(ctx, *opts.(*arvados.LoginOptions))
  80                         },
  81                 },
  82                 {
  83                         arvados.EndpointLogout,
  84                         func() interface{} { return &arvados.LogoutOptions{} },
  85                         func(ctx context.Context, opts interface{}) (interface{}, error) {
  86                                 return rtr.backend.Logout(ctx, *opts.(*arvados.LogoutOptions))
  87                         },
  88                 },
  89                 {
  90                         arvados.EndpointCollectionCreate,
  91                         func() interface{} { return &arvados.CreateOptions{} },
  92                         func(ctx context.Context, opts interface{}) (interface{}, error) {
  93                                 return rtr.backend.CollectionCreate(ctx, *opts.(*arvados.CreateOptions))
  94                         },
  95                 },
  96                 {
  97                         arvados.EndpointCollectionUpdate,
  98                         func() interface{} { return &arvados.UpdateOptions{} },
  99                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 100                                 return rtr.backend.CollectionUpdate(ctx, *opts.(*arvados.UpdateOptions))
 101                         },
 102                 },
 103                 {
 104                         arvados.EndpointCollectionGet,
 105                         func() interface{} { return &arvados.GetOptions{} },
 106                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 107                                 return rtr.backend.CollectionGet(ctx, *opts.(*arvados.GetOptions))
 108                         },
 109                 },
 110                 {
 111                         arvados.EndpointCollectionList,
 112                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 113                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 114                                 return rtr.backend.CollectionList(ctx, *opts.(*arvados.ListOptions))
 115                         },
 116                 },
 117                 {
 118                         arvados.EndpointCollectionProvenance,
 119                         func() interface{} { return &arvados.GetOptions{} },
 120                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 121                                 return rtr.backend.CollectionProvenance(ctx, *opts.(*arvados.GetOptions))
 122                         },
 123                 },
 124                 {
 125                         arvados.EndpointCollectionUsedBy,
 126                         func() interface{} { return &arvados.GetOptions{} },
 127                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 128                                 return rtr.backend.CollectionUsedBy(ctx, *opts.(*arvados.GetOptions))
 129                         },
 130                 },
 131                 {
 132                         arvados.EndpointCollectionDelete,
 133                         func() interface{} { return &arvados.DeleteOptions{} },
 134                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 135                                 return rtr.backend.CollectionDelete(ctx, *opts.(*arvados.DeleteOptions))
 136                         },
 137                 },
 138                 {
 139                         arvados.EndpointCollectionTrash,
 140                         func() interface{} { return &arvados.DeleteOptions{} },
 141                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 142                                 return rtr.backend.CollectionTrash(ctx, *opts.(*arvados.DeleteOptions))
 143                         },
 144                 },
 145                 {
 146                         arvados.EndpointCollectionUntrash,
 147                         func() interface{} { return &arvados.UntrashOptions{} },
 148                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 149                                 return rtr.backend.CollectionUntrash(ctx, *opts.(*arvados.UntrashOptions))
 150                         },
 151                 },
 152                 {
 153                         arvados.EndpointContainerCreate,
 154                         func() interface{} { return &arvados.CreateOptions{} },
 155                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 156                                 return rtr.backend.ContainerCreate(ctx, *opts.(*arvados.CreateOptions))
 157                         },
 158                 },
 159                 {
 160                         arvados.EndpointContainerUpdate,
 161                         func() interface{} { return &arvados.UpdateOptions{} },
 162                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 163                                 return rtr.backend.ContainerUpdate(ctx, *opts.(*arvados.UpdateOptions))
 164                         },
 165                 },
 166                 {
 167                         arvados.EndpointContainerGet,
 168                         func() interface{} { return &arvados.GetOptions{} },
 169                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 170                                 return rtr.backend.ContainerGet(ctx, *opts.(*arvados.GetOptions))
 171                         },
 172                 },
 173                 {
 174                         arvados.EndpointContainerList,
 175                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 176                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 177                                 return rtr.backend.ContainerList(ctx, *opts.(*arvados.ListOptions))
 178                         },
 179                 },
 180                 {
 181                         arvados.EndpointContainerDelete,
 182                         func() interface{} { return &arvados.DeleteOptions{} },
 183                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 184                                 return rtr.backend.ContainerDelete(ctx, *opts.(*arvados.DeleteOptions))
 185                         },
 186                 },
 187                 {
 188                         arvados.EndpointContainerRequestCreate,
 189                         func() interface{} { return &arvados.CreateOptions{} },
 190                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 191                                 return rtr.backend.ContainerRequestCreate(ctx, *opts.(*arvados.CreateOptions))
 192                         },
 193                 },
 194                 {
 195                         arvados.EndpointContainerRequestUpdate,
 196                         func() interface{} { return &arvados.UpdateOptions{} },
 197                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 198                                 return rtr.backend.ContainerRequestUpdate(ctx, *opts.(*arvados.UpdateOptions))
 199                         },
 200                 },
 201                 {
 202                         arvados.EndpointContainerRequestGet,
 203                         func() interface{} { return &arvados.GetOptions{} },
 204                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 205                                 return rtr.backend.ContainerRequestGet(ctx, *opts.(*arvados.GetOptions))
 206                         },
 207                 },
 208                 {
 209                         arvados.EndpointContainerRequestList,
 210                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 211                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 212                                 return rtr.backend.ContainerRequestList(ctx, *opts.(*arvados.ListOptions))
 213                         },
 214                 },
 215                 {
 216                         arvados.EndpointContainerRequestDelete,
 217                         func() interface{} { return &arvados.DeleteOptions{} },
 218                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 219                                 return rtr.backend.ContainerRequestDelete(ctx, *opts.(*arvados.DeleteOptions))
 220                         },
 221                 },
 222                 {
 223                         arvados.EndpointContainerLock,
 224                         func() interface{} {
 225                                 return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}}
 226                         },
 227                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 228                                 return rtr.backend.ContainerLock(ctx, *opts.(*arvados.GetOptions))
 229                         },
 230                 },
 231                 {
 232                         arvados.EndpointContainerUnlock,
 233                         func() interface{} {
 234                                 return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}}
 235                         },
 236                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 237                                 return rtr.backend.ContainerUnlock(ctx, *opts.(*arvados.GetOptions))
 238                         },
 239                 },
 240                 {
 241                         arvados.EndpointContainerSSH,
 242                         func() interface{} { return &arvados.ContainerSSHOptions{} },
 243                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 244                                 return rtr.backend.ContainerSSH(ctx, *opts.(*arvados.ContainerSSHOptions))
 245                         },
 246                 },
 247                 {
 248                         // arvados-client built before commit
 249                         // bdc29d3129f6d75aa9ce0a24ffb849a272b06f08
 250                         // used GET with params in headers instead of
 251                         // POST form
 252                         arvados.APIEndpoint{"GET", "arvados/v1/connect/{uuid}/ssh", ""},
 253                         func() interface{} { return &arvados.ContainerSSHOptions{} },
 254                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 255                                 return nil, httpError(http.StatusGone, fmt.Errorf("API endpoint is obsolete -- please upgrade your arvados-client program"))
 256                         },
 257                 },
 258                 {
 259                         arvados.EndpointContainerGatewayTunnel,
 260                         func() interface{} { return &arvados.ContainerGatewayTunnelOptions{} },
 261                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 262                                 return rtr.backend.ContainerGatewayTunnel(ctx, *opts.(*arvados.ContainerGatewayTunnelOptions))
 263                         },
 264                 },
 265                 {
 266                         arvados.EndpointGroupCreate,
 267                         func() interface{} { return &arvados.CreateOptions{} },
 268                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 269                                 return rtr.backend.GroupCreate(ctx, *opts.(*arvados.CreateOptions))
 270                         },
 271                 },
 272                 {
 273                         arvados.EndpointGroupUpdate,
 274                         func() interface{} { return &arvados.UpdateOptions{} },
 275                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 276                                 return rtr.backend.GroupUpdate(ctx, *opts.(*arvados.UpdateOptions))
 277                         },
 278                 },
 279                 {
 280                         arvados.EndpointGroupList,
 281                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 282                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 283                                 return rtr.backend.GroupList(ctx, *opts.(*arvados.ListOptions))
 284                         },
 285                 },
 286                 {
 287                         arvados.EndpointGroupContents,
 288                         func() interface{} { return &arvados.GroupContentsOptions{Limit: -1} },
 289                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 290                                 return rtr.backend.GroupContents(ctx, *opts.(*arvados.GroupContentsOptions))
 291                         },
 292                 },
 293                 {
 294                         arvados.EndpointGroupContentsUUIDInPath,
 295                         func() interface{} { return &arvados.GroupContentsOptions{Limit: -1} },
 296                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 297                                 return rtr.backend.GroupContents(ctx, *opts.(*arvados.GroupContentsOptions))
 298                         },
 299                 },
 300                 {
 301                         arvados.EndpointGroupShared,
 302                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 303                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 304                                 return rtr.backend.GroupShared(ctx, *opts.(*arvados.ListOptions))
 305                         },
 306                 },
 307                 {
 308                         arvados.EndpointGroupGet,
 309                         func() interface{} { return &arvados.GetOptions{} },
 310                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 311                                 return rtr.backend.GroupGet(ctx, *opts.(*arvados.GetOptions))
 312                         },
 313                 },
 314                 {
 315                         arvados.EndpointGroupDelete,
 316                         func() interface{} { return &arvados.DeleteOptions{} },
 317                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 318                                 return rtr.backend.GroupDelete(ctx, *opts.(*arvados.DeleteOptions))
 319                         },
 320                 },
 321                 {
 322                         arvados.EndpointGroupTrash,
 323                         func() interface{} { return &arvados.DeleteOptions{} },
 324                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 325                                 return rtr.backend.GroupTrash(ctx, *opts.(*arvados.DeleteOptions))
 326                         },
 327                 },
 328                 {
 329                         arvados.EndpointGroupUntrash,
 330                         func() interface{} { return &arvados.UntrashOptions{} },
 331                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 332                                 return rtr.backend.GroupUntrash(ctx, *opts.(*arvados.UntrashOptions))
 333                         },
 334                 },
 335                 {
 336                         arvados.EndpointLinkCreate,
 337                         func() interface{} { return &arvados.CreateOptions{} },
 338                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 339                                 return rtr.backend.LinkCreate(ctx, *opts.(*arvados.CreateOptions))
 340                         },
 341                 },
 342                 {
 343                         arvados.EndpointLinkUpdate,
 344                         func() interface{} { return &arvados.UpdateOptions{} },
 345                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 346                                 return rtr.backend.LinkUpdate(ctx, *opts.(*arvados.UpdateOptions))
 347                         },
 348                 },
 349                 {
 350                         arvados.EndpointLinkList,
 351                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 352                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 353                                 return rtr.backend.LinkList(ctx, *opts.(*arvados.ListOptions))
 354                         },
 355                 },
 356                 {
 357                         arvados.EndpointLinkGet,
 358                         func() interface{} { return &arvados.GetOptions{} },
 359                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 360                                 return rtr.backend.LinkGet(ctx, *opts.(*arvados.GetOptions))
 361                         },
 362                 },
 363                 {
 364                         arvados.EndpointLinkDelete,
 365                         func() interface{} { return &arvados.DeleteOptions{} },
 366                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 367                                 return rtr.backend.LinkDelete(ctx, *opts.(*arvados.DeleteOptions))
 368                         },
 369                 },
 370                 {
 371                         arvados.EndpointLogCreate,
 372                         func() interface{} { return &arvados.CreateOptions{} },
 373                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 374                                 return rtr.backend.LogCreate(ctx, *opts.(*arvados.CreateOptions))
 375                         },
 376                 },
 377                 {
 378                         arvados.EndpointLogUpdate,
 379                         func() interface{} { return &arvados.UpdateOptions{} },
 380                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 381                                 return rtr.backend.LogUpdate(ctx, *opts.(*arvados.UpdateOptions))
 382                         },
 383                 },
 384                 {
 385                         arvados.EndpointLogList,
 386                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 387                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 388                                 return rtr.backend.LogList(ctx, *opts.(*arvados.ListOptions))
 389                         },
 390                 },
 391                 {
 392                         arvados.EndpointLogGet,
 393                         func() interface{} { return &arvados.GetOptions{} },
 394                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 395                                 return rtr.backend.LogGet(ctx, *opts.(*arvados.GetOptions))
 396                         },
 397                 },
 398                 {
 399                         arvados.EndpointLogDelete,
 400                         func() interface{} { return &arvados.DeleteOptions{} },
 401                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 402                                 return rtr.backend.LogDelete(ctx, *opts.(*arvados.DeleteOptions))
 403                         },
 404                 },
 405                 {
 406                         arvados.EndpointSpecimenCreate,
 407                         func() interface{} { return &arvados.CreateOptions{} },
 408                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 409                                 return rtr.backend.SpecimenCreate(ctx, *opts.(*arvados.CreateOptions))
 410                         },
 411                 },
 412                 {
 413                         arvados.EndpointSpecimenUpdate,
 414                         func() interface{} { return &arvados.UpdateOptions{} },
 415                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 416                                 return rtr.backend.SpecimenUpdate(ctx, *opts.(*arvados.UpdateOptions))
 417                         },
 418                 },
 419                 {
 420                         arvados.EndpointSpecimenGet,
 421                         func() interface{} { return &arvados.GetOptions{} },
 422                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 423                                 return rtr.backend.SpecimenGet(ctx, *opts.(*arvados.GetOptions))
 424                         },
 425                 },
 426                 {
 427                         arvados.EndpointSpecimenList,
 428                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 429                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 430                                 return rtr.backend.SpecimenList(ctx, *opts.(*arvados.ListOptions))
 431                         },
 432                 },
 433                 {
 434                         arvados.EndpointSpecimenDelete,
 435                         func() interface{} { return &arvados.DeleteOptions{} },
 436                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 437                                 return rtr.backend.SpecimenDelete(ctx, *opts.(*arvados.DeleteOptions))
 438                         },
 439                 },
 440                 {
 441                         arvados.EndpointAPIClientAuthorizationCreate,
 442                         func() interface{} { return &arvados.CreateOptions{} },
 443                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 444                                 return rtr.backend.APIClientAuthorizationCreate(ctx, *opts.(*arvados.CreateOptions))
 445                         },
 446                 },
 447                 {
 448                         arvados.EndpointAPIClientAuthorizationUpdate,
 449                         func() interface{} { return &arvados.UpdateOptions{} },
 450                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 451                                 return rtr.backend.APIClientAuthorizationUpdate(ctx, *opts.(*arvados.UpdateOptions))
 452                         },
 453                 },
 454                 {
 455                         arvados.EndpointAPIClientAuthorizationDelete,
 456                         func() interface{} { return &arvados.DeleteOptions{} },
 457                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 458                                 return rtr.backend.APIClientAuthorizationDelete(ctx, *opts.(*arvados.DeleteOptions))
 459                         },
 460                 },
 461                 {
 462                         arvados.EndpointAPIClientAuthorizationList,
 463                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 464                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 465                                 return rtr.backend.APIClientAuthorizationList(ctx, *opts.(*arvados.ListOptions))
 466                         },
 467                 },
 468                 {
 469                         arvados.EndpointAPIClientAuthorizationCurrent,
 470                         func() interface{} { return &arvados.GetOptions{} },
 471                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 472                                 return rtr.backend.APIClientAuthorizationCurrent(ctx, *opts.(*arvados.GetOptions))
 473                         },
 474                 },
 475                 {
 476                         arvados.EndpointAPIClientAuthorizationGet,
 477                         func() interface{} { return &arvados.GetOptions{} },
 478                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 479                                 return rtr.backend.APIClientAuthorizationGet(ctx, *opts.(*arvados.GetOptions))
 480                         },
 481                 },
 482                 {
 483                         arvados.EndpointUserCreate,
 484                         func() interface{} { return &arvados.CreateOptions{} },
 485                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 486                                 return rtr.backend.UserCreate(ctx, *opts.(*arvados.CreateOptions))
 487                         },
 488                 },
 489                 {
 490                         arvados.EndpointUserMerge,
 491                         func() interface{} { return &arvados.UserMergeOptions{} },
 492                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 493                                 return rtr.backend.UserMerge(ctx, *opts.(*arvados.UserMergeOptions))
 494                         },
 495                 },
 496                 {
 497                         arvados.EndpointUserActivate,
 498                         func() interface{} { return &arvados.UserActivateOptions{} },
 499                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 500                                 return rtr.backend.UserActivate(ctx, *opts.(*arvados.UserActivateOptions))
 501                         },
 502                 },
 503                 {
 504                         arvados.EndpointUserSetup,
 505                         func() interface{} { return &arvados.UserSetupOptions{} },
 506                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 507                                 return rtr.backend.UserSetup(ctx, *opts.(*arvados.UserSetupOptions))
 508                         },
 509                 },
 510                 {
 511                         arvados.EndpointUserUnsetup,
 512                         func() interface{} { return &arvados.GetOptions{} },
 513                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 514                                 return rtr.backend.UserUnsetup(ctx, *opts.(*arvados.GetOptions))
 515                         },
 516                 },
 517                 {
 518                         arvados.EndpointUserGetCurrent,
 519                         func() interface{} { return &arvados.GetOptions{} },
 520                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 521                                 return rtr.backend.UserGetCurrent(ctx, *opts.(*arvados.GetOptions))
 522                         },
 523                 },
 524                 {
 525                         arvados.EndpointUserGetSystem,
 526                         func() interface{} { return &arvados.GetOptions{} },
 527                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 528                                 return rtr.backend.UserGetSystem(ctx, *opts.(*arvados.GetOptions))
 529                         },
 530                 },
 531                 {
 532                         arvados.EndpointUserGet,
 533                         func() interface{} { return &arvados.GetOptions{} },
 534                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 535                                 return rtr.backend.UserGet(ctx, *opts.(*arvados.GetOptions))
 536                         },
 537                 },
 538                 {
 539                         arvados.EndpointUserUpdate,
 540                         func() interface{} { return &arvados.UpdateOptions{} },
 541                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 542                                 return rtr.backend.UserUpdate(ctx, *opts.(*arvados.UpdateOptions))
 543                         },
 544                 },
 545                 {
 546                         arvados.EndpointUserList,
 547                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
 548                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 549                                 return rtr.backend.UserList(ctx, *opts.(*arvados.ListOptions))
 550                         },
 551                 },
 552                 {
 553                         arvados.EndpointUserBatchUpdate,
 554                         func() interface{} { return &arvados.UserBatchUpdateOptions{} },
 555                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 556                                 return rtr.backend.UserBatchUpdate(ctx, *opts.(*arvados.UserBatchUpdateOptions))
 557                         },
 558                 },
 559                 {
 560                         arvados.EndpointUserDelete,
 561                         func() interface{} { return &arvados.DeleteOptions{} },
 562                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 563                                 return rtr.backend.UserDelete(ctx, *opts.(*arvados.DeleteOptions))
 564                         },
 565                 },
 566                 {
 567                         arvados.EndpointUserAuthenticate,
 568                         func() interface{} { return &arvados.UserAuthenticateOptions{} },
 569                         func(ctx context.Context, opts interface{}) (interface{}, error) {
 570                                 return rtr.backend.UserAuthenticate(ctx, *opts.(*arvados.UserAuthenticateOptions))
 571                         },
 572                 },
 573         } {
 574                 exec := route.exec
 575                 if rtr.config.WrapCalls != nil {
 576                         exec = rtr.config.WrapCalls(exec)
 577                 }
 578                 rtr.addRoute(route.endpoint, route.defaultOpts, exec)
 579         }
 580         rtr.mux.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 581                 httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusNotFound)
 582         })
 583         rtr.mux.MethodNotAllowedHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 584                 httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusMethodNotAllowed)
 585         })
 586 }
 587
 588 var altMethod = map[string]string{
 589         "PATCH": "PUT",  // Accept PUT as a synonym for PATCH
 590         "GET":   "HEAD", // Accept HEAD at any GET route
 591 }
 592
 593 func (rtr *router) addRoute(endpoint arvados.APIEndpoint, defaultOpts func() interface{}, exec api.RoutableFunc) {
 594         methods := []string{endpoint.Method}
 595         if alt, ok := altMethod[endpoint.Method]; ok {
 596                 methods = append(methods, alt)
 597         }
 598         rtr.mux.Methods(methods...).Path("/" + endpoint.Path).HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 599                 logger := ctxlog.FromContext(req.Context())
 600                 params, err := rtr.loadRequestParams(req, endpoint.AttrsKey)
 601                 if err != nil {
 602                         logger.WithFields(logrus.Fields{
 603                                 "req":      req,
 604                                 "method":   endpoint.Method,
 605                                 "endpoint": endpoint,
 606                         }).WithError(err).Debug("error loading request params")
 607                         rtr.sendError(w, err)
 608                         return
 609                 }
 610                 opts := defaultOpts()
 611                 err = rtr.transcode(params, opts)
 612                 if err != nil {
 613                         logger.WithField("params", params).WithError(err).Debugf("error transcoding params to %T", opts)
 614                         rtr.sendError(w, err)
 615                         return
 616                 }
 617                 respOpts, err := rtr.responseOptions(opts)
 618                 if err != nil {
 619                         logger.WithField("opts", opts).WithError(err).Debugf("error getting response options from %T", opts)
 620                         rtr.sendError(w, err)
 621                         return
 622                 }
 623
 624                 creds := auth.CredentialsFromRequest(req)
 625                 err = creds.LoadTokensFromHTTPRequestBody(req)
 626                 if err != nil {
 627                         rtr.sendError(w, fmt.Errorf("error loading tokens from request body: %s", err))
 628                         return
 629                 }
 630                 if rt, _ := params["reader_tokens"].([]interface{}); len(rt) > 0 {
 631                         for _, t := range rt {
 632                                 if t, ok := t.(string); ok {
 633                                         creds.Tokens = append(creds.Tokens, t)
 634                                 }
 635                         }
 636                 }
 637                 ctx := auth.NewContext(req.Context(), creds)
 638                 ctx = arvados.ContextWithRequestID(ctx, req.Header.Get("X-Request-Id"))
 639                 logger.WithFields(logrus.Fields{
 640                         "apiEndpoint": endpoint,
 641                         "apiOptsType": fmt.Sprintf("%T", opts),
 642                         "apiOpts":     opts,
 643                 }).Debug("exec")
 644                 // Extract the token UUIDs (or a placeholder for v1 tokens)
 645                 var tokenUUIDs []string
 646                 for _, t := range creds.Tokens {
 647                         if strings.HasPrefix(t, "v2/") {
 648                                 tokenParts := strings.Split(t, "/")
 649                                 if len(tokenParts) >= 3 {
 650                                         tokenUUIDs = append(tokenUUIDs, tokenParts[1])
 651                                 }
 652                         } else {
 653                                 end := t
 654                                 if len(t) > 5 {
 655                                         end = t[len(t)-5:]
 656                                 }
 657                                 tokenUUIDs = append(tokenUUIDs, "v1 token ending in "+end)
 658                         }
 659                 }
 660                 httpserver.SetResponseLogFields(req.Context(), logrus.Fields{"tokenUUIDs": tokenUUIDs})
 661                 resp, err := exec(ctx, opts)
 662                 if err != nil {
 663                         logger.WithError(err).Debugf("returning error type %T", err)
 664                         rtr.sendError(w, err)
 665                         return
 666                 }
 667                 rtr.sendResponse(w, req, resp, respOpts)
 668         })
 669 }
 670
 671 func (rtr *router) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 672         switch strings.SplitN(strings.TrimLeft(r.URL.Path, "/"), "/", 2)[0] {
 673         case "login", "logout", "auth":
 674         default:
 675                 w.Header().Set("Access-Control-Allow-Origin", "*")
 676                 w.Header().Set("Access-Control-Allow-Methods", "GET, HEAD, PUT, POST, PATCH, DELETE")
 677                 w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type, X-Http-Method-Override")
 678                 w.Header().Set("Access-Control-Max-Age", "86486400")
 679         }
 680         if r.Method == "OPTIONS" {
 681                 return
 682         }
 683         if r.Body != nil {
 684                 // Wrap r.Body in a http.MaxBytesReader(), otherwise
 685                 // r.ParseForm() uses a default max request body size
 686                 // of 10 megabytes. Note we rely on the Nginx
 687                 // configuration to enforce the real max body size.
 688                 max := int64(rtr.config.MaxRequestSize)
 689                 if max < 1 {
 690                         max = math.MaxInt64 - 1
 691                 }
 692                 r.Body = http.MaxBytesReader(w, r.Body, max)
 693         }
 694         if r.Method == "POST" {
 695                 err := r.ParseForm()
 696                 if err != nil {
 697                         if err.Error() == "http: request body too large" {
 698                                 err = httpError(http.StatusRequestEntityTooLarge, err)
 699                         }
 700                         rtr.sendError(w, err)
 701                         return
 702                 }
 703                 if m := r.FormValue("_method"); m != "" {
 704                         r2 := *r
 705                         r = &r2
 706                         r.Method = m
 707                 } else if m = r.Header.Get("X-Http-Method-Override"); m != "" {
 708                         r2 := *r
 709                         r = &r2
 710                         r.Method = m
 711                 }
 712         }
 713         rtr.mux.ServeHTTP(w, r)
 714 }