github.com/cs3org/reva/v2@v2.27.7/pkg/rhttp/global/global.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package global
    20  
    21  import (
    22  	"net/http"
    23  
    24  	"github.com/rs/zerolog"
    25  )
    26  
    27  // NewMiddlewares contains all the registered new middleware functions.
    28  var NewMiddlewares = map[string]NewMiddleware{}
    29  
    30  // NewMiddleware is the function that HTTP middlewares need to register at init time.
    31  type NewMiddleware func(conf map[string]interface{}) (Middleware, int, error)
    32  
    33  // RegisterMiddleware registers a new HTTP middleware and its new function.
    34  func RegisterMiddleware(name string, n NewMiddleware) {
    35  	NewMiddlewares[name] = n
    36  }
    37  
    38  // Middleware is a middleware http handler.
    39  type Middleware func(h http.Handler) http.Handler
    40  
    41  // Services is a map of service name and its new function.
    42  var Services = map[string]NewService{}
    43  
    44  // Register registers a new HTTP services with name and new function.
    45  func Register(name string, newFunc NewService) {
    46  	Services[name] = newFunc
    47  }
    48  
    49  // NewService is the function that HTTP services need to register at init time.
    50  type NewService func(conf map[string]interface{}, log *zerolog.Logger) (Service, error)
    51  
    52  // Service represents a HTTP service.
    53  type Service interface {
    54  	Handler() http.Handler
    55  	Prefix() string
    56  	Close() error
    57  	// List of url relative to the prefix to be unprotected by the authentication
    58  	// middleware. To be seen if we need url-verb fine grained skip checks like
    59  	// GET is public and POST is not.
    60  	Unprotected() []string
    61  }