-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.go
688 lines (593 loc) · 26.9 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
package config
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"runtime"
"sync"
"sync/atomic"
"time"
"github.com/kelseyhightower/envconfig"
"github.com/TykTechnologies/tyk/apidef"
logger "github.com/TykTechnologies/tyk/log"
"github.com/TykTechnologies/tyk/regexp"
)
type IPsHandleStrategy string
var (
log = logger.Get()
global atomic.Value
globalMu sync.Mutex
Default = Config{
ListenPort: 8080,
Secret: "352d20ee67be67f6340b4c0605b044b7",
TemplatePath: "templates",
MiddlewarePath: "middleware",
AppPath: "apps/",
Storage: StorageOptionsConf{
Type: "redis",
Host: "localhost",
MaxIdle: 100,
Port: 6379,
},
AnalyticsConfig: AnalyticsConfigConfig{
IgnoredIPs: make([]string, 0),
},
DnsCache: DnsCacheConfig{
Enabled: false,
TTL: dnsCacheDefaultTtl,
CheckInterval: dnsCacheDefaultCheckInterval,
MultipleIPsHandleStrategy: NoCacheStrategy,
},
}
)
const (
envPrefix = "TYK_GW"
dnsCacheDefaultTtl = 3600
dnsCacheDefaultCheckInterval = 60
PickFirstStrategy IPsHandleStrategy = "pick_first"
RandomStrategy IPsHandleStrategy = "random"
NoCacheStrategy IPsHandleStrategy = "no_cache"
DefaultDashPolicySource = "service"
DefaultDashPolicyRecordName = "tyk_policies"
)
type PoliciesConfig struct {
PolicySource string `json:"policy_source"`
PolicyConnectionString string `json:"policy_connection_string"`
PolicyRecordName string `json:"policy_record_name"`
AllowExplicitPolicyID bool `json:"allow_explicit_policy_id"`
}
type DBAppConfOptionsConfig struct {
ConnectionString string `json:"connection_string"`
NodeIsSegmented bool `json:"node_is_segmented"`
Tags []string `json:"tags"`
}
type StorageOptionsConf struct {
Type string `json:"type"`
Host string `json:"host"`
Port int `json:"port"`
Hosts map[string]string `json:"hosts"` // Deprecated: Addrs instead.
Addrs []string `json:"addrs"`
MasterName string `json:"master_name"`
Username string `json:"username"`
Password string `json:"password"`
Database int `json:"database"`
MaxIdle int `json:"optimisation_max_idle"`
MaxActive int `json:"optimisation_max_active"`
Timeout int `json:"timeout"`
EnableCluster bool `json:"enable_cluster"`
UseSSL bool `json:"use_ssl"`
SSLInsecureSkipVerify bool `json:"ssl_insecure_skip_verify"`
}
type NormalisedURLConfig struct {
Enabled bool `json:"enabled"`
NormaliseUUIDs bool `json:"normalise_uuids"`
NormaliseNumbers bool `json:"normalise_numbers"`
Custom []string `json:"custom_patterns"`
CompiledPatternSet NormaliseURLPatterns `json:"-"` // see analytics.go
}
type NormaliseURLPatterns struct {
UUIDs *regexp.Regexp
IDs *regexp.Regexp
Custom []*regexp.Regexp
}
type AnalyticsConfigConfig struct {
Type string `json:"type"`
IgnoredIPs []string `json:"ignored_ips"`
EnableDetailedRecording bool `json:"enable_detailed_recording"`
EnableGeoIP bool `json:"enable_geo_ip"`
GeoIPDBLocation string `json:"geo_ip_db_path"`
NormaliseUrls NormalisedURLConfig `json:"normalise_urls"`
PoolSize int `json:"pool_size"`
RecordsBufferSize uint64 `json:"records_buffer_size"`
StorageExpirationTime int `json:"storage_expiration_time"`
ignoredIPsCompiled map[string]bool
}
type HealthCheckConfig struct {
EnableHealthChecks bool `json:"enable_health_checks"`
HealthCheckValueTimeout int64 `json:"health_check_value_timeouts"`
}
type DnsCacheConfig struct {
Enabled bool `json:"enabled"`
TTL int64 `json:"ttl"`
CheckInterval int64 `json:"-" ignored:"true"` //controls cache cleanup interval. By convention shouldn't be exposed to config or env_variable_setup
MultipleIPsHandleStrategy IPsHandleStrategy `json:"multiple_ips_handle_strategy"`
}
type MonitorConfig 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"`
}
type WebHookHandlerConf struct {
Method string `bson:"method" json:"method"`
TargetPath string `bson:"target_path" json:"target_path"`
TemplatePath string `bson:"template_path" json:"template_path"`
HeaderList map[string]string `bson:"header_map" json:"header_map"`
EventTimeout int64 `bson:"event_timeout" json:"event_timeout"`
}
type SlaveOptionsConfig struct {
UseRPC bool `json:"use_rpc"`
UseSSL bool `json:"use_ssl"`
SSLInsecureSkipVerify bool `json:"ssl_insecure_skip_verify"`
ConnectionString string `json:"connection_string"`
RPCKey string `json:"rpc_key"`
APIKey string `json:"api_key"`
EnableRPCCache bool `json:"enable_rpc_cache"`
BindToSlugsInsteadOfListenPaths bool `json:"bind_to_slugs"`
DisableKeySpaceSync bool `json:"disable_keyspace_sync"`
GroupID string `json:"group_id"`
CallTimeout int `json:"call_timeout"`
PingTimeout int `json:"ping_timeout"`
RPCPoolSize int `json:"rpc_pool_size"`
}
type LocalSessionCacheConf struct {
DisableCacheSessionState bool `json:"disable_cached_session_state"`
CachedSessionTimeout int `json:"cached_session_timeout"`
CacheSessionEviction int `json:"cached_session_eviction"`
}
type HttpServerOptionsConfig struct {
OverrideDefaults bool `json:"override_defaults"`
ReadTimeout int `json:"read_timeout"`
WriteTimeout int `json:"write_timeout"`
UseSSL bool `json:"use_ssl"`
UseLE_SSL bool `json:"use_ssl_le"`
EnableHttp2 bool `json:"enable_http2"`
SSLInsecureSkipVerify bool `json:"ssl_insecure_skip_verify"`
EnableWebSockets bool `json:"enable_websockets"`
Certificates []CertData `json:"certificates"`
SSLCertificates []string `json:"ssl_certificates"`
ServerName string `json:"server_name"`
MinVersion uint16 `json:"min_version"`
FlushInterval int `json:"flush_interval"`
SkipURLCleaning bool `json:"skip_url_cleaning"`
SkipTargetPathEscaping bool `json:"skip_target_path_escaping"`
Ciphers []string `json:"ssl_ciphers"`
}
type AuthOverrideConf struct {
ForceAuthProvider bool `json:"force_auth_provider"`
AuthProvider apidef.AuthProviderMeta `json:"auth_provider"`
ForceSessionProvider bool `json:"force_session_provider"`
SessionProvider apidef.SessionProviderMeta `json:"session_provider"`
}
type UptimeTestsConfigDetail struct {
FailureTriggerSampleSize int `json:"failure_trigger_sample_size"`
TimeWait int `json:"time_wait"`
CheckerPoolSize int `json:"checker_pool_size"`
EnableUptimeAnalytics bool `json:"enable_uptime_analytics"`
}
type UptimeTestsConfig struct {
Disable bool `json:"disable"`
PollerGroup string `json:"poller_group"`
Config UptimeTestsConfigDetail `json:"config"`
}
type ServiceDiscoveryConf struct {
DefaultCacheTimeout int `json:"default_cache_timeout"`
}
type CoProcessConfig struct {
EnableCoProcess bool `json:"enable_coprocess"`
CoProcessGRPCServer string `json:"coprocess_grpc_server"`
GRPCRecvMaxSize int `json:"grpc_recv_max_size"`
GRPCSendMaxSize int `json:"grpc_send_max_size"`
PythonPathPrefix string `json:"python_path_prefix"`
PythonVersion string `json:"python_version"`
}
type CertificatesConfig struct {
API []string `json:"apis"`
Upstream map[string]string `json:"upstream"`
ControlAPI []string `json:"control_api"`
Dashboard []string `json:"dashboard_api"`
MDCB []string `json:"mdcb_api"`
}
type SecurityConfig struct {
PrivateCertificateEncodingSecret string `json:"private_certificate_encoding_secret"`
ControlAPIUseMutualTLS bool `json:"control_api_use_mutual_tls"`
PinnedPublicKeys map[string]string `json:"pinned_public_keys"`
Certificates CertificatesConfig `json:"certificates"`
}
type NewRelicConfig struct {
AppName string `json:"app_name"`
LicenseKey string `json:"license_key"`
}
type Tracer struct {
// The name of the tracer to initialize. For instance appdash, to use appdash
// tracer
Name string `json:"name"`
// If true then this tracer will be activated and all tracing data will be sent
// to this tracer.NoOp tracer is used otherwise which collects traces but
// discard them.
Enabled bool `json:"enabled"`
// Key value pairs used to initialize the tracer. These are tracer specific,
// each tracer requires different options to operate. Please see trace package
// for options required by supported tracer implementation.
Options map[string]interface{} `json:"options"`
}
// ServicePort defines a protocol and port on which a service can bind to
type ServicePort struct {
Protocol string `json:"protocol"`
Port int `json:"port"`
}
// PortWhiteList defines ports that will be allowed by the gateway.
type PortWhiteList struct {
Ranges []PortRange `json:"ranges,omitempty"`
Ports []int `json:"ports,omitempty"`
}
// Match returns true if port is acceptable from the PortWhiteList.
func (p PortWhiteList) Match(port int) bool {
for _, v := range p.Ports {
if port == v {
return true
}
}
for _, r := range p.Ranges {
if r.Match(port) {
return true
}
}
return false
}
// PortRange defines a range of ports inclusively.
type PortRange struct {
From int `json:"from"`
To int `json:"to"`
}
// Match returns true if port is within the range
func (r PortRange) Match(port int) bool {
return r.From <= port && r.To >= port
}
// Config is the configuration object used by tyk to set up various parameters.
type Config struct {
// OriginalPath is the path to the config file that was read. If
// none was found, it's the path to the default config file that
// was written.
OriginalPath string `json:"-"`
HostName string `json:"hostname"`
ListenAddress string `json:"listen_address"`
ListenPort int `json:"listen_port"`
ControlAPIHostname string `json:"control_api_hostname"`
ControlAPIPort int `json:"control_api_port"`
Secret string `json:"secret"`
NodeSecret string `json:"node_secret"`
PIDFileLocation string `json:"pid_file_location"`
AllowInsecureConfigs bool `json:"allow_insecure_configs"`
PublicKeyPath string `json:"public_key_path"`
AllowRemoteConfig bool `bson:"allow_remote_config" json:"allow_remote_config"`
Security SecurityConfig `json:"security"`
HttpServerOptions HttpServerOptionsConfig `json:"http_server_options"`
ReloadWaitTime int `bson:"reload_wait_time" json:"reload_wait_time"`
VersionHeader string `json:"version_header"`
SuppressRedisSignalReload bool `json:"suppress_redis_signal_reload"`
// Gateway Security Policies
HashKeys bool `json:"hash_keys"`
HashKeyFunction string `json:"hash_key_function"`
HashKeyFunctionFallback []string `json:"hash_key_function_fallback"`
EnableHashedKeysListing bool `json:"enable_hashed_keys_listing"`
MinTokenLength int `json:"min_token_length"`
EnableAPISegregation bool `json:"enable_api_segregation"`
TemplatePath string `json:"template_path"`
Policies PoliciesConfig `json:"policies"`
DisablePortWhiteList bool `json:"disable_ports_whitelist"`
// Defines the ports that will be available for the api services to bind to.
// This is a map of protocol to PortWhiteList. This allows per protocol
// configurations.
PortWhiteList map[string]PortWhiteList `json:"ports_whitelist"`
// CE Configurations
AppPath string `json:"app_path"`
// Dashboard Configurations
UseDBAppConfigs bool `json:"use_db_app_configs"`
DBAppConfOptions DBAppConfOptionsConfig `json:"db_app_conf_options"`
Storage StorageOptionsConf `json:"storage"`
DisableDashboardZeroConf bool `json:"disable_dashboard_zeroconf"`
// Slave Configurations
SlaveOptions SlaveOptionsConfig `json:"slave_options"`
ManagementNode bool `json:"management_node"`
AuthOverride AuthOverrideConf `json:"auth_override"`
// Rate Limiting Strategy
EnableNonTransactionalRateLimiter bool `json:"enable_non_transactional_rate_limiter"`
EnableSentinelRateLimiter bool `json:"enable_sentinel_rate_limiter"`
EnableRedisRollingLimiter bool `json:"enable_redis_rolling_limiter"`
DRLNotificationFrequency int `json:"drl_notification_frequency"`
DRLEnableSentinelRateLimiter bool `json:"drl_enable_sentinel_rate_limiter"`
DRLThreshold float64 `json:"drl_threshold"`
// Organization configurations
EnforceOrgDataAge bool `json:"enforce_org_data_age"`
EnforceOrgDataDetailLogging bool `json:"enforce_org_data_detail_logging"`
EnforceOrgQuotas bool `json:"enforce_org_quotas"`
ExperimentalProcessOrgOffThread bool `json:"experimental_process_org_off_thread"`
Monitor MonitorConfig `json:"monitor"`
// Client-Gateway Configuration
MaxIdleConns int `bson:"max_idle_connections" json:"max_idle_connections"`
MaxIdleConnsPerHost int `bson:"max_idle_connections_per_host" json:"max_idle_connections_per_host"`
MaxConnTime int64 `json:"max_conn_time"`
CloseIdleConnections bool `json:"close_idle_connections"`
CloseConnections bool `json:"close_connections"`
EnableCustomDomains bool `json:"enable_custom_domains"`
// If AllowMasterKeys is set to true, session objects (key definitions) that do not have explicit access rights set
// will be allowed by Tyk. This means that keys that are created have access to ALL APIs, which in many cases is
// unwanted behaviour unless you are sure about what you are doing.
AllowMasterKeys bool `json:"allow_master_keys"`
// Gateway-Service Configuration
ServiceDiscovery ServiceDiscoveryConf `json:"service_discovery"`
ProxySSLInsecureSkipVerify bool `json:"proxy_ssl_insecure_skip_verify"`
ProxyEnableHttp2 bool `json:"proxy_enable_http2"`
ProxySSLMinVersion uint16 `json:"proxy_ssl_min_version"`
ProxySSLCipherSuites []string `json:"proxy_ssl_ciphers"`
ProxyDefaultTimeout float64 `json:"proxy_default_timeout"`
ProxySSLDisableRenegotiation bool `json:"proxy_ssl_disable_renegotiation"`
ProxyCloseConnections bool `json:"proxy_close_connections"`
UptimeTests UptimeTestsConfig `json:"uptime_tests"`
HealthCheck HealthCheckConfig `json:"health_check"`
OauthRefreshExpire int64 `json:"oauth_refresh_token_expire"`
OauthTokenExpire int32 `json:"oauth_token_expire"`
OauthTokenExpiredRetainPeriod int32 `json:"oauth_token_expired_retain_period"`
OauthRedirectUriSeparator string `json:"oauth_redirect_uri_separator"`
OauthErrorStatusCode int `json:"oauth_error_status_code"`
EnableKeyLogging bool `json:"enable_key_logging"`
SSLForceCommonNameCheck bool `json:"ssl_force_common_name_check"`
// Proxy analytics configuration
EnableAnalytics bool `json:"enable_analytics"`
AnalyticsConfig AnalyticsConfigConfig `json:"analytics_config"`
// Cache
DnsCache DnsCacheConfig `json:"dns_cache"`
DisableRegexpCache bool `json:"disable_regexp_cache"`
RegexpCacheExpire int32 `json:"regexp_cache_expire"`
LocalSessionCache LocalSessionCacheConf `json:"local_session_cache"`
EnableSeperateCacheStore bool `json:"enable_separate_cache_store"`
CacheStorage StorageOptionsConf `json:"cache_storage"`
// Middleware/Plugin Configuration
EnableBundleDownloader bool `bson:"enable_bundle_downloader" json:"enable_bundle_downloader"`
BundleBaseURL string `bson:"bundle_base_url" json:"bundle_base_url"`
BundleInsecureSkipVerify bool `bson:"bundle_insecure_skip_verify" json:"bundle_insecure_skip_verify"`
EnableJSVM bool `json:"enable_jsvm"`
JSVMTimeout int `json:"jsvm_timeout"`
DisableVirtualPathBlobs bool `json:"disable_virtual_path_blobs"`
TykJSPath string `json:"tyk_js_path"`
MiddlewarePath string `json:"middleware_path"`
CoProcessOptions CoProcessConfig `json:"coprocess_options"`
IgnoreEndpointCase bool `json:"ignore_endpoint_case"`
// Monitoring, Logging & Profiling
LogLevel string `json:"log_level"`
HealthCheckEndpointName string `json:"health_check_endpoint_name"`
Tracer Tracer `json:"tracing"`
NewRelic NewRelicConfig `json:"newrelic"`
HTTPProfile bool `json:"enable_http_profiler"`
UseRedisLog bool `json:"use_redis_log"`
SentryCode string `json:"sentry_code"`
SentryLogLevel string `json:"sentry_log_level"`
UseSentry bool `json:"use_sentry"`
UseSyslog bool `json:"use_syslog"`
UseGraylog bool `json:"use_graylog"`
UseLogstash bool `json:"use_logstash"`
GraylogNetworkAddr string `json:"graylog_network_addr"`
LogstashNetworkAddr string `json:"logstash_network_addr"`
SyslogTransport string `json:"syslog_transport"`
LogstashTransport string `json:"logstash_transport"`
SyslogNetworkAddr string `json:"syslog_network_addr"`
StatsdConnectionString string `json:"statsd_connection_string"`
StatsdPrefix string `json:"statsd_prefix"`
// Event System
EventHandlers apidef.EventHandlerMetaConfig `json:"event_handlers"`
EventTriggers map[apidef.TykEvent][]TykEventHandler `json:"event_trigers_defunct"` // Deprecated: Config.GetEventTriggers instead.
EventTriggersDefunct map[apidef.TykEvent][]TykEventHandler `json:"event_triggers_defunct"` // Deprecated: Config.GetEventTriggers instead.
// TODO: These config options are not documented - What do they do?
SupressDefaultOrgStore bool `json:"suppress_default_org_store"`
LegacyEnableAllowanceCountdown bool `bson:"legacy_enable_allowance_countdown" json:"legacy_enable_allowance_countdown"`
GlobalSessionLifetime int64 `bson:"global_session_lifetime" json:"global_session_lifetime"`
ForceGlobalSessionLifetime bool `bson:"force_global_session_lifetime" json:"force_global_session_lifetime"`
HideGeneratorHeader bool `json:"hide_generator_header"`
KV struct {
Consul ConsulConfig `json:"consul"`
Vault VaultConfig `json:"vault"`
} `json:"kv"`
// Secrets are key-value pairs that can be accessed in the dashboard via "secrets://"
Secrets map[string]string `json:"secrets"`
// OverrideMessages is used to override returned API error codes and messages.
OverrideMessages map[string]TykError `bson:"override_messages" json:"override_messages"`
}
type TykError struct {
Message string `json:"message"`
Code int `json:"code"`
}
// VaultConfig is used to configure the creation of a client
// This is a stripped down version of the Config struct in vault's API client
type VaultConfig struct {
// Address is the address of the Vault server. This should be a complete
// URL such as "http://vault.example.com".
Address string `json:"address"`
// AgentAddress is the address of the local Vault agent. This should be a
// complete URL such as "http://vault.example.com".
AgentAddress string `json:"agent_address"`
// MaxRetries controls the maximum number of times to retry when a vault
// serer occurs
MaxRetries int `json:"max_retries"`
Timeout time.Duration `json:"timeout"`
// Token is the vault root token
Token string `json:"token"`
// KVVersion is the version number of Vault. Usually defaults to 2
KVVersion int `json:"kv_version"`
}
// ConsulConfig is used to configure the creation of a client
// This is a stripped down version of the Config struct in consul's API client
type ConsulConfig struct {
// Address is the address of the Consul server
Address string `json:"address"`
// Scheme is the URI scheme for the Consul server
Scheme string `json:"scheme"`
// Datacenter to use. If not provided, the default agent datacenter is used.
Datacenter string `json:"datacenter"`
// HttpAuth is the auth info to use for http access.
HttpAuth struct {
// Username to use for HTTP Basic Authentication
Username string `json:"username"`
// Password to use for HTTP Basic Authentication
Password string `json:"password"`
} `json:"http_auth"`
// WaitTime limits how long a Watch will block. If not provided,
// the agent default values will be used.
WaitTime time.Duration `json:"wait_time"`
// Token is used to provide a per-request ACL token
// which overrides the agent's default token.
Token string `json:"token"`
TLSConfig struct {
Address string `json:"address"`
CAFile string `json:"ca_file"`
CAPath string `json:"ca_path"`
CertFile string `json:"cert_file"`
KeyFile string `json:"key_file"`
InsecureSkipVerify bool `json:"insecure_skip_verify"`
} `json:"tls_config"`
}
// GetEventTriggers returns event triggers. There was a typo in the json tag.
// To maintain backward compatibility, this solution is chosen.
func (c Config) GetEventTriggers() map[apidef.TykEvent][]TykEventHandler {
if c.EventTriggersDefunct == nil {
return c.EventTriggers
}
if c.EventTriggers != nil {
log.Info("Both event_trigers_defunct and event_triggers_defunct are configured in the config," +
" event_triggers_defunct will be used.")
}
return c.EventTriggersDefunct
}
func (c *Config) SetEventTriggers(eventTriggers map[apidef.TykEvent][]TykEventHandler) {
c.EventTriggersDefunct = eventTriggers
}
type CertData struct {
Name string `json:"domain_name"`
CertFile string `json:"cert_file"`
KeyFile string `json:"key_file"`
}
// EventMessage is a standard form to send event data to handlers
type EventMessage struct {
Type apidef.TykEvent
Meta interface{}
TimeStamp string
}
// TykEventHandler defines an event handler, e.g. LogMessageEventHandler will handle an event by logging it to stdout.
type TykEventHandler interface {
Init(interface{}) error
HandleEvent(EventMessage)
}
func init() {
SetGlobal(Config{})
}
func Global() Config {
return global.Load().(Config)
}
func SetGlobal(conf Config) {
globalMu.Lock()
defer globalMu.Unlock()
global.Store(conf)
}
func WriteConf(path string, conf *Config) error {
bs, err := json.MarshalIndent(conf, "", " ")
if err != nil {
return err
}
return ioutil.WriteFile(path, bs, 0644)
}
// writeDefault will set conf to the default config and write it to disk
// in path, if the path is non-empty.
func WriteDefault(path string, conf *Config) error {
_, b, _, _ := runtime.Caller(0)
configPath := filepath.Dir(b)
rootPath := filepath.Dir(configPath)
Default.TemplatePath = filepath.Join(rootPath, "templates")
*conf = Default
if err := envconfig.Process(envPrefix, conf); err != nil {
return err
}
if path == "" {
return nil
}
return WriteConf(path, conf)
}
// Load will load a configuration file, trying each of the paths given
// and using the first one that is a regular file and can be opened.
//
// If none exists, a default config will be written to the first path in
// the list.
//
// An error will be returned only if any of the paths existed but was
// not a valid config file.
func Load(paths []string, conf *Config) error {
var r io.Reader
for _, path := range paths {
f, err := os.Open(path)
if err == nil {
r = f
conf.OriginalPath = path
break
}
if os.IsNotExist(err) {
continue
}
return err
}
if r == nil {
path := paths[0]
log.Warnf("No config file found, writing default to %s", path)
if err := WriteDefault(path, conf); err != nil {
return err
}
log.Info("Loading default configuration...")
return Load([]string{path}, conf)
}
if err := json.NewDecoder(r).Decode(&conf); err != nil {
return fmt.Errorf("couldn't unmarshal config: %v", err)
}
if err := envconfig.Process(envPrefix, conf); err != nil {
return fmt.Errorf("failed to process config env vars: %v", err)
}
if err := processCustom(envPrefix, conf, loadZipkin, loadJaeger); err != nil {
return fmt.Errorf("failed to process config custom loader: %v", err)
}
return nil
}
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) StoreAnalytics(ip string) bool {
if !c.EnableAnalytics {
return false
}
return !c.AnalyticsConfig.ignoredIPsCompiled[ip]
}
// processCustom these are custom functions for loadign config values. They will
// be called in the order they are passed. Any function that returns an error
// then that error will be returned and no further processing will be
// happenning.
func processCustom(prefix string, c *Config, custom ...func(prefix string, c *Config) error) error {
for _, fn := range custom {
if err := fn(prefix, c); err != nil {
return err
}
}
return nil
}