diff options
Diffstat (limited to 'plugins/http/config/http.go')
-rw-r--r-- | plugins/http/config/http.go | 222 |
1 files changed, 222 insertions, 0 deletions
diff --git a/plugins/http/config/http.go b/plugins/http/config/http.go new file mode 100644 index 00000000..76547fde --- /dev/null +++ b/plugins/http/config/http.go @@ -0,0 +1,222 @@ +package config + +import ( + "net" + "os" + "runtime" + "strings" + "time" + + "github.com/spiral/errors" + poolImpl "github.com/spiral/roadrunner/v2/pkg/pool" +) + +// HTTP configures RoadRunner HTTP server. +type HTTP struct { + // Port and port to handle as http server. + Address string + + // SSLConfig defines https server options. + SSLConfig *SSL `mapstructure:"ssl"` + + // FCGIConfig configuration. You can use FastCGI without HTTP server. + FCGIConfig *FCGI `mapstructure:"fcgi"` + + // HTTP2Config configuration + HTTP2Config *HTTP2 `mapstructure:"http2"` + + // MaxRequestSize specified max size for payload body in megabytes, set 0 to unlimited. + MaxRequestSize uint64 `mapstructure:"max_request_size"` + + // TrustedSubnets declare IP subnets which are allowed to set ip using X-Real-Ip and X-Forwarded-For + TrustedSubnets []string `mapstructure:"trusted_subnets"` + + // Uploads configures uploads configuration. + Uploads *Uploads `mapstructure:"uploads"` + + // Pool configures worker pool. + Pool *poolImpl.Config `mapstructure:"pool"` + + // Env is environment variables passed to the http pool + Env map[string]string + + // List of the middleware names (order will be preserved) + Middleware []string + + // slice of net.IPNet + Cidrs Cidrs +} + +// EnableHTTP is true when http server must run. +func (c *HTTP) EnableHTTP() bool { + return c.Address != "" +} + +// EnableTLS returns true if pool must listen TLS connections. +func (c *HTTP) EnableTLS() bool { + return c.SSLConfig.Key != "" || c.SSLConfig.Cert != "" || c.SSLConfig.RootCA != "" +} + +// EnableH2C when HTTP/2 extension must be enabled on TCP. +func (c *HTTP) EnableH2C() bool { + return c.HTTP2Config.H2C +} + +// EnableFCGI is true when FastCGI server must be enabled. +func (c *HTTP) EnableFCGI() bool { + return c.FCGIConfig.Address != "" +} + +// InitDefaults must populate HTTP values using given HTTP source. Must return error if HTTP is not valid. +func (c *HTTP) InitDefaults() error { + if c.Pool == nil { + // default pool + c.Pool = &poolImpl.Config{ + Debug: false, + NumWorkers: int64(runtime.NumCPU()), + MaxJobs: 1000, + AllocateTimeout: time.Second * 60, + DestroyTimeout: time.Second * 60, + Supervisor: nil, + } + } + + if c.HTTP2Config == nil { + c.HTTP2Config = &HTTP2{} + } + + if c.FCGIConfig == nil { + c.FCGIConfig = &FCGI{} + } + + if c.Uploads == nil { + c.Uploads = &Uploads{} + } + + if c.SSLConfig == nil { + c.SSLConfig = &SSL{} + } + + if c.SSLConfig.Port == 0 { + c.SSLConfig.Port = 443 + } + + err := c.HTTP2Config.InitDefaults() + if err != nil { + return err + } + err = c.Uploads.InitDefaults() + if err != nil { + return err + } + + if c.TrustedSubnets == nil { + // @see https://en.wikipedia.org/wiki/Reserved_IP_addresses + c.TrustedSubnets = []string{ + "10.0.0.0/8", + "127.0.0.0/8", + "172.16.0.0/12", + "192.168.0.0/16", + "::1/128", + "fc00::/7", + "fe80::/10", + } + } + + cidrs, err := ParseCIDRs(c.TrustedSubnets) + if err != nil { + return err + } + c.Cidrs = cidrs + + return c.Valid() +} + +// ParseCIDRs parse IPNet addresses and return slice of its +func ParseCIDRs(subnets []string) (Cidrs, error) { + c := make(Cidrs, 0, len(subnets)) + for _, cidr := range subnets { + _, cr, err := net.ParseCIDR(cidr) + if err != nil { + return nil, err + } + + c = append(c, cr) + } + + return c, nil +} + +// IsTrusted if api can be trusted to use X-Real-Ip, X-Forwarded-For +func (c *HTTP) IsTrusted(ip string) bool { + if c.Cidrs == nil { + return false + } + + i := net.ParseIP(ip) + if i == nil { + return false + } + + for _, cird := range c.Cidrs { + if cird.Contains(i) { + return true + } + } + + return false +} + +// Valid validates the configuration. +func (c *HTTP) Valid() error { + const op = errors.Op("validation") + if c.Uploads == nil { + return errors.E(op, errors.Str("malformed uploads config")) + } + + if c.HTTP2Config == nil { + return errors.E(op, errors.Str("malformed http2 config")) + } + + if c.Pool == nil { + return errors.E(op, "malformed pool config") + } + + if !c.EnableHTTP() && !c.EnableTLS() && !c.EnableFCGI() { + return errors.E(op, errors.Str("unable to run http service, no method has been specified (http, https, http/2 or FastCGI)")) + } + + if c.Address != "" && !strings.Contains(c.Address, ":") { + return errors.E(op, errors.Str("malformed http server address")) + } + + if c.EnableTLS() { + if _, err := os.Stat(c.SSLConfig.Key); err != nil { + if os.IsNotExist(err) { + return errors.E(op, errors.Errorf("key file '%s' does not exists", c.SSLConfig.Key)) + } + + return err + } + + if _, err := os.Stat(c.SSLConfig.Cert); err != nil { + if os.IsNotExist(err) { + return errors.E(op, errors.Errorf("cert file '%s' does not exists", c.SSLConfig.Cert)) + } + + return err + } + + // RootCA is optional, but if provided - check it + if c.SSLConfig.RootCA != "" { + if _, err := os.Stat(c.SSLConfig.RootCA); err != nil { + if os.IsNotExist(err) { + return errors.E(op, errors.Errorf("root ca path provided, but path '%s' does not exists", c.SSLConfig.RootCA)) + } + return err + } + } + } + + return nil +} |