adb290ed2d
This adds support for handling preflight requests in the REST API and fixes currently mostly broken CORS. Before we just let the user add custom response headers to the configuration "headers" key but this is not the best way because CORs headers and requests need special handling and doing it wrong has security implications. Therefore, I have added specific CORS-related configuration options which control CORS behavour. We are forced to change the "headers" defaults and will notify the users about this in the changelog. License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
434 lines
12 KiB
Go
434 lines
12 KiB
Go
package rest
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"github.com/ipfs/ipfs-cluster/config"
|
|
"github.com/rs/cors"
|
|
|
|
"github.com/kelseyhightower/envconfig"
|
|
|
|
crypto "github.com/libp2p/go-libp2p-crypto"
|
|
peer "github.com/libp2p/go-libp2p-peer"
|
|
ma "github.com/multiformats/go-multiaddr"
|
|
)
|
|
|
|
const configKey = "restapi"
|
|
const envConfigKey = "cluster_restapi"
|
|
|
|
// These are the default values for Config
|
|
const (
|
|
DefaultHTTPListenAddr = "/ip4/127.0.0.1/tcp/9094"
|
|
DefaultReadTimeout = 0
|
|
DefaultReadHeaderTimeout = 5 * time.Second
|
|
DefaultWriteTimeout = 0
|
|
DefaultIdleTimeout = 120 * time.Second
|
|
)
|
|
|
|
// These are the default values for Config.
|
|
var (
|
|
DefaultHeaders = map[string][]string{}
|
|
)
|
|
|
|
// CORS defaults
|
|
var (
|
|
DefaultCORSAllowedOrigins = []string{"*"}
|
|
DefaultCORSAllowedMethods = []string{
|
|
http.MethodGet,
|
|
}
|
|
// rs/cors this will set sensible defaults when empty:
|
|
// {"Origin", "Accept", "Content-Type", "X-Requested-With"}
|
|
DefaultCORSAllowedHeaders = []string{}
|
|
DefaultCORSExposedHeaders = []string{
|
|
"Content-Type",
|
|
"X-Stream-Output",
|
|
"X-Chunked-Output",
|
|
"X-Content-Length",
|
|
}
|
|
DefaultCORSAllowCredentials = true
|
|
DefaultCORSMaxAge time.Duration = 0
|
|
)
|
|
|
|
// Config is used to intialize the API object and allows to
|
|
// customize the behaviour of it. It implements the config.ComponentConfig
|
|
// interface.
|
|
type Config struct {
|
|
config.Saver
|
|
|
|
// Listen address for the HTTP REST API endpoint.
|
|
HTTPListenAddr ma.Multiaddr
|
|
|
|
// TLS configuration for the HTTP listener
|
|
TLS *tls.Config
|
|
|
|
// pathSSLCertFile is a path to a certificate file used to secure the
|
|
// HTTP API endpoint. We track it so we can write it in the JSON.
|
|
pathSSLCertFile string
|
|
|
|
// pathSSLKeyFile is a path to the private key corresponding to the
|
|
// SSLKeyFile. We track it so we can write it in the JSON.
|
|
pathSSLKeyFile string
|
|
|
|
// Maximum duration before timing out reading a full request
|
|
ReadTimeout time.Duration
|
|
|
|
// Maximum duration before timing out reading the headers of a request
|
|
ReadHeaderTimeout time.Duration
|
|
|
|
// Maximum duration before timing out write of the response
|
|
WriteTimeout time.Duration
|
|
|
|
// Server-side amount of time a Keep-Alive connection will be
|
|
// kept idle before being reused
|
|
IdleTimeout time.Duration
|
|
|
|
// Listen address for the Libp2p REST API endpoint.
|
|
Libp2pListenAddr ma.Multiaddr
|
|
|
|
// ID and PrivateKey are used to create a libp2p host if we
|
|
// want the API component to do it (not by default).
|
|
ID peer.ID
|
|
PrivateKey crypto.PrivKey
|
|
|
|
// BasicAuthCreds is a map of username-password pairs
|
|
// which are authorized to use Basic Authentication
|
|
BasicAuthCreds map[string]string
|
|
|
|
// Headers provides customization for the headers returned
|
|
// by the API on existing routes.
|
|
Headers map[string][]string
|
|
|
|
// CORS header management
|
|
CORSAllowedOrigins []string
|
|
CORSAllowedMethods []string
|
|
CORSAllowedHeaders []string
|
|
CORSExposedHeaders []string
|
|
CORSAllowCredentials bool
|
|
CORSMaxAge time.Duration
|
|
}
|
|
|
|
type jsonConfig struct {
|
|
ListenMultiaddress string `json:"listen_multiaddress,omitempty"` // backwards compat
|
|
HTTPListenMultiaddress string `json:"http_listen_multiaddress"`
|
|
SSLCertFile string `json:"ssl_cert_file,omitempty"`
|
|
SSLKeyFile string `json:"ssl_key_file,omitempty"`
|
|
ReadTimeout string `json:"read_timeout"`
|
|
ReadHeaderTimeout string `json:"read_header_timeout"`
|
|
WriteTimeout string `json:"write_timeout"`
|
|
IdleTimeout string `json:"idle_timeout"`
|
|
|
|
Libp2pListenMultiaddress string `json:"libp2p_listen_multiaddress,omitempty"`
|
|
ID string `json:"id,omitempty"`
|
|
PrivateKey string `json:"private_key,omitempty"`
|
|
|
|
BasicAuthCreds map[string]string `json:"basic_auth_credentials"`
|
|
Headers map[string][]string `json:"headers"`
|
|
|
|
CORSAllowedOrigins []string `json:"cors_allowed_origins"`
|
|
CORSAllowedMethods []string `json:"cors_allowed_methods"`
|
|
CORSAllowedHeaders []string `json:"cors_allowed_headers"`
|
|
CORSExposedHeaders []string `json:"cors_exposed_headers"`
|
|
CORSAllowCredentials bool `json:"cors_allow_credentials"`
|
|
CORSMaxAge string `json:"cors_max_age"`
|
|
}
|
|
|
|
// ConfigKey returns a human-friendly identifier for this type of
|
|
// Config.
|
|
func (cfg *Config) ConfigKey() string {
|
|
return configKey
|
|
}
|
|
|
|
// Default initializes this Config with working values.
|
|
func (cfg *Config) Default() error {
|
|
// http
|
|
httpListen, _ := ma.NewMultiaddr(DefaultHTTPListenAddr)
|
|
cfg.HTTPListenAddr = httpListen
|
|
cfg.pathSSLCertFile = ""
|
|
cfg.pathSSLKeyFile = ""
|
|
cfg.ReadTimeout = DefaultReadTimeout
|
|
cfg.ReadHeaderTimeout = DefaultReadHeaderTimeout
|
|
cfg.WriteTimeout = DefaultWriteTimeout
|
|
cfg.IdleTimeout = DefaultIdleTimeout
|
|
|
|
// libp2p
|
|
cfg.ID = ""
|
|
cfg.PrivateKey = nil
|
|
cfg.Libp2pListenAddr = nil
|
|
|
|
// Auth
|
|
cfg.BasicAuthCreds = nil
|
|
|
|
// Headers
|
|
cfg.Headers = DefaultHeaders
|
|
|
|
cfg.CORSAllowedOrigins = DefaultCORSAllowedOrigins
|
|
cfg.CORSAllowedMethods = DefaultCORSAllowedMethods
|
|
cfg.CORSAllowedHeaders = DefaultCORSAllowedHeaders
|
|
cfg.CORSExposedHeaders = DefaultCORSExposedHeaders
|
|
cfg.CORSAllowCredentials = DefaultCORSAllowCredentials
|
|
cfg.CORSMaxAge = DefaultCORSMaxAge
|
|
|
|
return nil
|
|
}
|
|
|
|
// Validate makes sure that all fields in this Config have
|
|
// working values, at least in appearance.
|
|
func (cfg *Config) Validate() error {
|
|
switch {
|
|
case cfg.ReadTimeout < 0:
|
|
return errors.New("restapi.read_timeout is invalid")
|
|
case cfg.ReadHeaderTimeout < 0:
|
|
return errors.New("restapi.read_header_timeout is invalid")
|
|
case cfg.WriteTimeout < 0:
|
|
return errors.New("restapi.write_timeout is invalid")
|
|
case cfg.IdleTimeout < 0:
|
|
return errors.New("restapi.idle_timeout invalid")
|
|
case cfg.BasicAuthCreds != nil && len(cfg.BasicAuthCreds) == 0:
|
|
return errors.New("restapi.basic_auth_creds should be null or have at least one entry")
|
|
case (cfg.pathSSLCertFile != "" || cfg.pathSSLKeyFile != "") && cfg.TLS == nil:
|
|
return errors.New("restapi: missing TLS configuration")
|
|
case (cfg.CORSMaxAge < 0):
|
|
return errors.New("restapi.cors_max_age is invalid")
|
|
}
|
|
|
|
return cfg.validateLibp2p()
|
|
}
|
|
|
|
func (cfg *Config) validateLibp2p() error {
|
|
if cfg.ID != "" || cfg.PrivateKey != nil || cfg.Libp2pListenAddr != nil {
|
|
// if one is set, all should be
|
|
if cfg.ID == "" || cfg.PrivateKey == nil || cfg.Libp2pListenAddr == nil {
|
|
return errors.New("all ID, private_key and libp2p_listen_multiaddress should be set")
|
|
}
|
|
if !cfg.ID.MatchesPrivateKey(cfg.PrivateKey) {
|
|
return errors.New("restapi.ID does not match private_key")
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// LoadJSON parses a raw JSON byte slice created by ToJSON() and sets the
|
|
// configuration fields accordingly.
|
|
func (cfg *Config) LoadJSON(raw []byte) error {
|
|
jcfg := &jsonConfig{}
|
|
err := json.Unmarshal(raw, jcfg)
|
|
if err != nil {
|
|
logger.Error("Error unmarshaling restapi config")
|
|
return err
|
|
}
|
|
|
|
cfg.Default()
|
|
|
|
// override json config with env var
|
|
err = envconfig.Process(envConfigKey, jcfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = cfg.loadHTTPOptions(jcfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = cfg.loadLibp2pOptions(jcfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Other options
|
|
cfg.BasicAuthCreds = jcfg.BasicAuthCreds
|
|
cfg.Headers = jcfg.Headers
|
|
|
|
return cfg.Validate()
|
|
}
|
|
|
|
func (cfg *Config) loadHTTPOptions(jcfg *jsonConfig) error {
|
|
// Deal with legacy ListenMultiaddress parameter
|
|
httpListen := jcfg.ListenMultiaddress
|
|
if httpListen != "" {
|
|
logger.Warning("restapi.listen_multiaddress has been replaced with http_listen_multiaddress and has been deprecated")
|
|
}
|
|
if l := jcfg.HTTPListenMultiaddress; l != "" {
|
|
httpListen = l
|
|
}
|
|
|
|
if httpListen != "" {
|
|
httpAddr, err := ma.NewMultiaddr(httpListen)
|
|
if err != nil {
|
|
err = fmt.Errorf("error parsing restapi.http_listen_multiaddress: %s", err)
|
|
return err
|
|
}
|
|
cfg.HTTPListenAddr = httpAddr
|
|
}
|
|
|
|
err := cfg.tlsOptions(jcfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// CORS
|
|
cfg.CORSAllowedOrigins = jcfg.CORSAllowedOrigins
|
|
cfg.CORSAllowedMethods = jcfg.CORSAllowedMethods
|
|
cfg.CORSAllowedHeaders = jcfg.CORSAllowedHeaders
|
|
cfg.CORSExposedHeaders = jcfg.CORSExposedHeaders
|
|
cfg.CORSAllowCredentials = jcfg.CORSAllowCredentials
|
|
|
|
return config.ParseDurations(
|
|
"restapi",
|
|
&config.DurationOpt{Duration: jcfg.ReadTimeout, Dst: &cfg.ReadTimeout, Name: "read_timeout"},
|
|
&config.DurationOpt{Duration: jcfg.ReadHeaderTimeout, Dst: &cfg.ReadHeaderTimeout, Name: "read_header_timeout"},
|
|
&config.DurationOpt{Duration: jcfg.WriteTimeout, Dst: &cfg.WriteTimeout, Name: "write_timeout"},
|
|
&config.DurationOpt{Duration: jcfg.IdleTimeout, Dst: &cfg.IdleTimeout, Name: "idle_timeout"},
|
|
&config.DurationOpt{Duration: jcfg.CORSMaxAge, Dst: &cfg.CORSMaxAge, Name: "cors_max_age"},
|
|
)
|
|
}
|
|
|
|
func (cfg *Config) tlsOptions(jcfg *jsonConfig) error {
|
|
cert := jcfg.SSLCertFile
|
|
key := jcfg.SSLKeyFile
|
|
|
|
if cert+key == "" {
|
|
return nil
|
|
}
|
|
|
|
cfg.pathSSLCertFile = cert
|
|
cfg.pathSSLKeyFile = key
|
|
|
|
if !filepath.IsAbs(cert) {
|
|
cert = filepath.Join(cfg.BaseDir, cert)
|
|
}
|
|
|
|
if !filepath.IsAbs(key) {
|
|
key = filepath.Join(cfg.BaseDir, key)
|
|
}
|
|
|
|
logger.Debug(cfg.BaseDir)
|
|
logger.Debug(cert, key)
|
|
|
|
tlsCfg, err := newTLSConfig(cert, key)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cfg.TLS = tlsCfg
|
|
return nil
|
|
}
|
|
|
|
func (cfg *Config) loadLibp2pOptions(jcfg *jsonConfig) error {
|
|
if libp2pListen := jcfg.Libp2pListenMultiaddress; libp2pListen != "" {
|
|
libp2pAddr, err := ma.NewMultiaddr(libp2pListen)
|
|
if err != nil {
|
|
err = fmt.Errorf("error parsing restapi.libp2p_listen_multiaddress: %s", err)
|
|
return err
|
|
}
|
|
cfg.Libp2pListenAddr = libp2pAddr
|
|
}
|
|
|
|
if jcfg.PrivateKey != "" {
|
|
pkb, err := base64.StdEncoding.DecodeString(jcfg.PrivateKey)
|
|
if err != nil {
|
|
return fmt.Errorf("error decoding restapi.private_key: %s", err)
|
|
}
|
|
pKey, err := crypto.UnmarshalPrivateKey(pkb)
|
|
if err != nil {
|
|
return fmt.Errorf("error parsing restapi.private_key ID: %s", err)
|
|
}
|
|
cfg.PrivateKey = pKey
|
|
}
|
|
|
|
if jcfg.ID != "" {
|
|
id, err := peer.IDB58Decode(jcfg.ID)
|
|
if err != nil {
|
|
return fmt.Errorf("error parsing restapi.ID: %s", err)
|
|
}
|
|
cfg.ID = id
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ToJSON produce a human-friendly JSON representation of the Config
|
|
// object.
|
|
func (cfg *Config) ToJSON() (raw []byte, err error) {
|
|
// Multiaddress String() may panic
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
err = fmt.Errorf("%s", r)
|
|
}
|
|
}()
|
|
|
|
jcfg := &jsonConfig{
|
|
HTTPListenMultiaddress: cfg.HTTPListenAddr.String(),
|
|
SSLCertFile: cfg.pathSSLCertFile,
|
|
SSLKeyFile: cfg.pathSSLKeyFile,
|
|
ReadTimeout: cfg.ReadTimeout.String(),
|
|
ReadHeaderTimeout: cfg.ReadHeaderTimeout.String(),
|
|
WriteTimeout: cfg.WriteTimeout.String(),
|
|
IdleTimeout: cfg.IdleTimeout.String(),
|
|
BasicAuthCreds: cfg.BasicAuthCreds,
|
|
Headers: cfg.Headers,
|
|
CORSAllowedOrigins: cfg.CORSAllowedOrigins,
|
|
CORSAllowedMethods: cfg.CORSAllowedMethods,
|
|
CORSAllowedHeaders: cfg.CORSAllowedHeaders,
|
|
CORSExposedHeaders: cfg.CORSExposedHeaders,
|
|
CORSAllowCredentials: cfg.CORSAllowCredentials,
|
|
CORSMaxAge: cfg.CORSMaxAge.String(),
|
|
}
|
|
|
|
if cfg.ID != "" {
|
|
jcfg.ID = peer.IDB58Encode(cfg.ID)
|
|
}
|
|
if cfg.PrivateKey != nil {
|
|
pkeyBytes, err := cfg.PrivateKey.Bytes()
|
|
if err == nil {
|
|
pKey := base64.StdEncoding.EncodeToString(pkeyBytes)
|
|
jcfg.PrivateKey = pKey
|
|
}
|
|
}
|
|
if cfg.Libp2pListenAddr != nil {
|
|
jcfg.Libp2pListenMultiaddress = cfg.Libp2pListenAddr.String()
|
|
}
|
|
|
|
raw, err = config.DefaultJSONMarshal(jcfg)
|
|
return
|
|
}
|
|
|
|
func (cfg *Config) corsOptions() *cors.Options {
|
|
maxAgeSeconds := int(cfg.CORSMaxAge / time.Second)
|
|
|
|
return &cors.Options{
|
|
AllowedOrigins: cfg.CORSAllowedOrigins,
|
|
AllowedMethods: cfg.CORSAllowedMethods,
|
|
AllowedHeaders: cfg.CORSAllowedHeaders,
|
|
ExposedHeaders: cfg.CORSExposedHeaders,
|
|
AllowCredentials: cfg.CORSAllowCredentials,
|
|
MaxAge: maxAgeSeconds,
|
|
Debug: false,
|
|
}
|
|
}
|
|
|
|
func newTLSConfig(certFile, keyFile string) (*tls.Config, error) {
|
|
cert, err := tls.LoadX509KeyPair(certFile, keyFile)
|
|
if err != nil {
|
|
return nil, errors.New("Error loading TLS certficate/key: " + err.Error())
|
|
}
|
|
// based on https://github.com/denji/golang-tls
|
|
return &tls.Config{
|
|
MinVersion: tls.VersionTLS12,
|
|
CurvePreferences: []tls.CurveID{tls.CurveP521, tls.CurveP384, tls.CurveP256},
|
|
PreferServerCipherSuites: true,
|
|
CipherSuites: []uint16{
|
|
tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
|
|
tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
|
|
tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
|
|
tls.TLS_RSA_WITH_AES_256_CBC_SHA,
|
|
},
|
|
Certificates: []tls.Certificate{cert},
|
|
}, nil
|
|
}
|