config.go

package main

import (
	"encoding/json"
	"github.com/lonelycode/tykcommon"
	"io/ioutil"
	"net"
	"net/http"
	"strings"
)

// Config is the configuration object used by tyk to set up various parameters.
type Config struct {
	ListenPort     int    `json:"listen_port"`
	Secret         string `json:"secret"`
	TemplatePath   string `json:"template_path"`
	TykJSPath      string `json:"tyk_js_path"`
	MiddlewarePath string `json:"middleware_path"`
	Policies       struct {
		PolicySource     string `json:"policy_source"`
		PolicyRecordName string `json:"policy_record_name"`
	} `json:"policies"`
	UseDBAppConfigs  bool `json:"use_db_app_configs"`
	DBAppConfOptions struct {
		NodeIsSegmented bool     `json:"node_is_segmented"`
		Tags            []string `json:"tags"`
	} `json:"db_app_conf_options"`
	AppPath string `json:"app_path"`
	Storage struct {
		Type     string `json:"type"`
		Host     string `json:"host"`
		Port     int    `json:"port"`
		Username string `json:"username"`
		Password string `json:"password"`
		Database int    `json:"database"`
		MaxIdle  int    `json:"optimisation_max_idle"`
	} `json:"storage"`
	EnableAnalytics bool `json:"enable_analytics"`
	AnalyticsConfig struct {
		Type               string   `json:"type"`
		CSVDir             string   `json:"csv_dir"`
		MongoURL           string   `json:"mongo_url"`
		MongoDbName        string   `json:"mongo_db_name"`
		MongoCollection    string   `json:"mongo_collection"`
		PurgeDelay         int      `json:"purge_delay"`
		IgnoredIPs         []string `json:"ignored_ips"`
		ignoredIPsCompiled map[string]bool
	} `json:"analytics_config"`
	HealthCheck struct {
		EnableHealthChecks      bool  `json:"enable_health_checks"`
		HealthCheckValueTimeout int64 `json:"health_check_value_timeouts"`
	} `json:"health_check"`
	UseAsyncSessionWrite            bool   `json:"optimisations_use_async_session_write"`
	AllowMasterKeys                 bool   `json:"allow_master_keys"`
	HashKeys                        bool   `json:"hash_keys"`
	SuppressRedisSignalReload       bool   `json:"suppress_redis_signal_reload"`
	SupressDefaultOrgStore          bool   `json:"suppress_default_org_store"`
	SentryCode                      string `json:"sentry_code"`
	UseSentry                       bool   `json:"use_sentry"`
	EnforceOrgDataAge               bool   `json:"enforce_org_data_age"`
	EnforceOrgQuotas                bool   `json:"enforce_org_quotas"`
	ExperimentalProcessOrgOffThread bool   `json:"experimental_process_org_off_thread"`
	Monitor                         struct {
		EnableTriggerMonitors bool               `json:"enable_trigger_monitors"`
		Config                WebHookHandlerConf `json:"configuration"`
		GlobalTriggerLimit    float64            `json:"global_trigger_limit"`
		MonitorUserKeys       bool               `json:"monitor_user_keys"`
		MonitorOrgKeys        bool               `json:"monitor_org_keys"`
	}
	OauthRefreshExpire int64 `json:"oauth_refresh_token_expire"`
	SlaveOptions       struct {
		UseRPC           bool   `json:"use_rpc"`
		ConnectionString string `json:"connection_string"`
		RPCKey           string `json:"rpc_key"`
		APIKey           string `json:"api_key"`
		EnableRPCCache   bool   `json:"enable_rpc_cache"`
	} `json:"slave_options"`
	DisableVirtualPathBlobs bool `json:"disable_virtual_path_blobs"`
	HttpServerOptions       struct {
		OverrideDefaults bool `json:"override_defaults"`
		ReadTimeout      int  `json:"read_timeout"`
		WriteTimeout     int  `json:"write_timeout"`
	} `json:"http_server_options"`
	ServiceDiscovery struct {
		DefaultCacheTimeout int `json:"default_cache_timeout"`
	} `json:"service_discovery"`
	CloseConnections bool `json:"close_connections"`
	AuthOverride     struct {
		ForceAuthProvider    bool                          `json:"force_auth_provider"`
		AuthProvider         tykcommon.AuthProviderMeta    `json:"auth_provider"`
		ForceSessionProvider bool                          `json:"force_session_provider"`
		SessionProvider      tykcommon.SessionProviderMeta `json:"session_provider"`
	} `json:"auth_override"`
}

// WriteDefaultConf will create a default configuration file and set the storage type to "memory"
func WriteDefaultConf(configStruct *Config) {
	configStruct.ListenPort = 8080
	configStruct.Secret = "352d20ee67be67f6340b4c0605b044b7"
	configStruct.TemplatePath = "./templates"
	configStruct.TykJSPath = "./js/tyk.js"
	configStruct.MiddlewarePath = "./middleware"
	configStruct.Storage.Type = "redis"
	configStruct.AppPath = "./apps/"
	configStruct.Storage.Host = "localhost"
	configStruct.Storage.Username = ""
	configStruct.Storage.Password = ""
	configStruct.Storage.Database = 0
	configStruct.Storage.MaxIdle = 100
	configStruct.Storage.Port = 6379
	configStruct.EnableAnalytics = false
	configStruct.HealthCheck.EnableHealthChecks = true
	configStruct.HealthCheck.HealthCheckValueTimeout = 60
	configStruct.AnalyticsConfig.CSVDir = "/tmp"
	configStruct.AnalyticsConfig.Type = "csv"
	configStruct.AnalyticsConfig.IgnoredIPs = make([]string, 0)
	configStruct.UseAsyncSessionWrite = false
	newConfig, err := json.MarshalIndent(configStruct, "", "    ")
	if err != nil {
		log.Error("Problem marshalling default configuration!")
		log.Error(err)
	} else {
		ioutil.WriteFile("tyk.conf", newConfig, 0644)
	}
}

// LoadConfig will load the configuration file from filePath, if it can't open
// the file for reading, it assumes there is no configuration file and will try to create
// one on the default path (tyk.conf in the local directory)
func loadConfig(filePath string, configStruct *Config) {
	configuration, err := ioutil.ReadFile(filePath)
	if err != nil {
		log.Error("Couldn't load configuration file")
		log.Error(err)
		log.Info("Writing a default file to ./tyk.conf")

		WriteDefaultConf(configStruct)

		log.Info("Loading default configuration...")
		loadConfig("tyk.conf", configStruct)
	} else {
		err := json.Unmarshal(configuration, &configStruct)
		if err != nil {
			log.Error("Couldn't unmarshal configuration")
			log.Error(err)
		}
	}
}

func (c *Config) loadIgnoredIPs() {
	c.AnalyticsConfig.ignoredIPsCompiled = make(map[string]bool, len(c.AnalyticsConfig.IgnoredIPs))
	for _, ip := range c.AnalyticsConfig.IgnoredIPs {
		c.AnalyticsConfig.ignoredIPsCompiled[ip] = true
	}
}

func (c *Config) TestShowIPs() {
	log.Warning(c.AnalyticsConfig.ignoredIPsCompiled)
}

func (c Config) StoreAnalytics(r *http.Request) bool {
	if !c.EnableAnalytics {
		return false
	}

	ip, _, _ := net.SplitHostPort(r.RemoteAddr)

	forwarded := r.Header.Get("X-FORWARDED-FOR")
	if forwarded != "" {
		ips := strings.Split(forwarded, ", ")
		ip = ips[0]
	}

	_, ignore := c.AnalyticsConfig.ignoredIPsCompiled[ip]

	return !ignore
}