-
Notifications
You must be signed in to change notification settings - Fork 15
/
config.go
351 lines (315 loc) · 13.5 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
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package server
import (
"bytes"
"context"
"crypto/rsa"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"path"
"strings"
"time"
"github.com/hashicorp/go-multierror"
"github.com/lestrrat-go/jwx/jwk"
"github.com/pkg/errors"
"github.com/prometheus/common/log"
"golang.org/x/oauth2/google"
"gopkg.in/yaml.v3"
)
const (
// LegacySaaSInternalBase is the internal API used for auth and analytics
LegacySaaSInternalBase = "https://istioservices.apigee.net/edgemicro"
// GCPExperienceBase is the default management API URL for GCP Experience
GCPExperienceBase = "https://apigee.googleapis.com"
// ServiceAccount is the json file with application credentials
ServiceAccount = "client_secret.json"
// DefaultAnalyticsSecretPath is the default path the analytics credentials directory
DefaultAnalyticsSecretPath = "/analytics-secret"
ApigeeAPIScope = "https://www.googleapis.com/auth/cloud-platform" // scope Apigee API needs
)
// DefaultConfig returns a config with defaults set
func DefaultConfig() *Config {
return &Config{
Global: GlobalConfig{
TempDir: "/tmp/apigee-istio",
KeepAliveMaxConnectionAge: time.Minute,
APIAddress: ":5000",
MetricsAddress: ":5001",
},
Tenant: TenantConfig{
ClientTimeout: 30 * time.Second,
InternalJWTDuration: 10 * time.Minute,
InternalJWTRefresh: 30 * time.Second,
},
Products: ProductsConfig{
RefreshRate: 2 * time.Minute,
},
Analytics: AnalyticsConfig{
FileLimit: 1024,
SendChannelSize: 10,
CollectionInterval: 2 * time.Minute,
},
Auth: AuthConfig{
APIKeyCacheDuration: 30 * time.Minute,
APIKeyHeader: "x-api-key",
TargetHeader: ":authority",
RejectUnauthorized: false,
},
}
}
// Config is all config
type Config struct {
Global GlobalConfig `yaml:"global,omitempty" json:"global,omitempty"`
Tenant TenantConfig `yaml:"tenant,omitempty" json:"tenant,omitempty"`
Products ProductsConfig `yaml:"products,omitempty" json:"products,omitempty"`
Analytics AnalyticsConfig `yaml:"analytics,omitempty" json:"analytics,omitempty"`
Auth AuthConfig `yaml:"auth,omitempty" json:"auth,omitempty"`
}
// GlobalConfig is global configuration for the server
type GlobalConfig struct {
APIAddress string `yaml:"api_address,omitempty" json:"api_address,omitempty"`
MetricsAddress string `yaml:"metrics_address,omitempty" json:"metrics_address,omitempty"`
TempDir string `yaml:"temp_dir,omitempty" json:"temp_dir,omitempty"`
KeepAliveMaxConnectionAge time.Duration `yaml:"keep_alive_max_connection_age,omitempty" json:"keep_alive_max_connection_age,omitempty"`
TLS TLSListenerConfig `yaml:"tls,omitempty" json:"tls,omitempty"`
Namespace string `yaml:"-" json:"-"`
}
// TLSListenerConfig is tls configuration
type TLSListenerConfig struct {
KeyFile string `yaml:"key_file,omitempty" json:"key_file,omitempty"`
CertFile string `yaml:"cert_file,omitempty" json:"cert_file,omitempty"`
}
// TLSClientConfig is mtls configuration
type TLSClientConfig struct {
CAFile string `yaml:"ca_file,omitempty" json:"ca_file,omitempty"`
KeyFile string `yaml:"key_file,omitempty" json:"key_file,omitempty"`
CertFile string `yaml:"cert_file,omitempty" json:"cert_file,omitempty"`
AllowUnverifiedSSLCert bool `yaml:"allow_unverified_ssl_cert,omitempty" json:"allow_unverified_ssl_cert,omitempty"`
}
// TenantConfig is config relating to an Apigee tentant
type TenantConfig struct {
InternalAPI string `yaml:"internal_api,omitempty" json:"internal_api,omitempty"`
RemoteServiceAPI string `yaml:"remote_service_api" json:"remote_service_api"`
OrgName string `yaml:"org_name" json:"org_name"`
EnvName string `yaml:"env_name" json:"env_name"`
Key string `yaml:"key,omitempty" json:"key,omitempty"`
Secret string `yaml:"secret,omitempty" json:"secret,omitempty"`
ClientTimeout time.Duration `yaml:"client_timeout,omitempty" json:"client_timeout,omitempty"`
AllowUnverifiedSSLCert bool `yaml:"allow_unverified_ssl_cert,omitempty" json:"allow_unverified_ssl_cert,omitempty"`
PrivateKey *rsa.PrivateKey `yaml:"-" json:"-"`
PrivateKeyID string `yaml:"-" json:"-"`
JWKS *jwk.Set `yaml:"-" json:"-"`
InternalJWTDuration time.Duration `yaml:"-" json:"-"`
InternalJWTRefresh time.Duration `yaml:"-" json:"-"`
}
// ProductsConfig is products-related config
type ProductsConfig struct {
RefreshRate time.Duration `yaml:"refresh_rate,omitempty" json:"refresh_rate,omitempty"`
}
// AnalyticsConfig is analytics-related config
type AnalyticsConfig struct {
LegacyEndpoint bool `yaml:"legacy_endpoint,omitempty" json:"legacy_endpoint,omitempty"`
FileLimit int `yaml:"file_limit,omitempty" json:"file_limit,omitempty"`
SendChannelSize int `yaml:"send_channel_size,omitempty" json:"send_channel_size,omitempty"`
CollectionInterval time.Duration `yaml:"collection_interval,omitempty" json:"collection_interval,omitempty"`
FluentdEndpoint string `yaml:"fluentd_endpoint,omitempty" json:"fluentd_endpoint,omitempty"`
TLS TLSClientConfig `yaml:"tls,omitempty" json:"tls,omitempty"`
CredentialsJSON []byte `yaml:"-" json:"-"`
Credentials *google.Credentials `yaml:"-" json:"-"`
}
// AuthConfig is auth-related config
type AuthConfig struct {
APIKeyClaim string `yaml:"api_key_claim,omitempty" json:"api_key_claim,omitempty"`
APIKeyCacheDuration time.Duration `yaml:"api_key_cache_duration,omitempty" json:"api_key_cache_duration,omitempty"`
JWKSPollInterval time.Duration `yaml:"jwks_poll_interval,omitempty" json:"jwks_poll_interval,omitempty"`
APIKeyHeader string `yaml:"api_key_header,omitempty" json:"api_key_header,omitempty"`
TargetHeader string `yaml:"target_header,omitempty" json:"target_header,omitempty"`
RejectUnauthorized bool `yaml:"reject_unauthorized,omitempty" json:"reject_unauthorized,omitempty"`
JWTProviderKey string `yaml:"jwt_provider_key,omitempty" json:"jwt_provider_key,omitempty"`
}
// Load config
func (c *Config) Load(configFile, policySecretPath, analyticsSecretPath string, requireAnalyticsCredentials bool) error {
log.Debugf("reading config from: %s", configFile)
yamlFile, err := ioutil.ReadFile(configFile)
if err != nil {
return err
}
// attempt load from CRD
var key, kidProps, jwksBytes []byte
var configBytes []byte
decoder := yaml.NewDecoder(bytes.NewReader(yamlFile))
crd := &ConfigMapCRD{}
for decoder.Decode(crd) != io.EOF {
if crd.Kind == "ConfigMap" {
configBytes = []byte(crd.Data["config.yaml"])
if configBytes != nil {
if err = yaml.Unmarshal(configBytes, c); err != nil {
return errors.Wrap(err, "bad config file format")
}
c.Global.Namespace = crd.Metadata.Namespace
}
} else if crd.Kind == "Secret" {
if strings.Contains(crd.Metadata.Name, "policy") {
key, _ = base64.StdEncoding.DecodeString(crd.Data[SecretPrivateKey])
kidProps, _ = base64.StdEncoding.DecodeString(crd.Data[SecretPropsKey])
jwksBytes, _ = base64.StdEncoding.DecodeString(crd.Data[SecretJWKSKey])
// check the lengths as DecodeString() only returns empty bytes
if len(key) == 0 || len(kidProps) == 0 || len(jwksBytes) == 0 { // all or nothing
key = nil
kidProps = nil
jwksBytes = nil
}
} else if strings.Contains(crd.Metadata.Name, "analytics") {
c.Analytics.CredentialsJSON, _ = base64.StdEncoding.DecodeString(crd.Data[ServiceAccount])
c.Analytics.Credentials, err = google.CredentialsFromJSON(context.Background(), c.Analytics.CredentialsJSON, ApigeeAPIScope)
if err != nil {
return err
}
}
}
}
// didn't load, try as simple config file
if configBytes == nil {
if err = yaml.Unmarshal(yamlFile, c); err != nil {
return errors.Wrap(err, "bad config file format")
}
}
// if no Secret, try files in policySecretPath
if c.IsGCPManaged() {
if policySecretPath != "" && key == nil {
if key, err = ioutil.ReadFile(path.Join(policySecretPath, SecretPrivateKey)); err == nil {
if kidProps, err = ioutil.ReadFile(path.Join(policySecretPath, SecretPropsKey)); err == nil {
jwksBytes, err = ioutil.ReadFile(path.Join(policySecretPath, SecretJWKSKey))
}
}
}
if err != nil {
return err
}
props, err := ReadProperties(bytes.NewReader(kidProps))
if err != nil {
return err
}
c.Tenant.PrivateKeyID = props[SecretPropsKIDKey]
jwks := &jwk.Set{}
if err = json.Unmarshal(jwksBytes, jwks); err == nil {
c.Tenant.JWKS = jwks
if c.Tenant.PrivateKey, err = loadPrivateKey(key, ""); err != nil {
return err
}
}
// attempts to load the service account credentials if a path is given
if analyticsSecretPath != "" {
svc := path.Join(analyticsSecretPath, ServiceAccount)
log.Debugf("using analytics service account credentials from: %s", svc)
sa, err := ioutil.ReadFile(svc)
if err != nil {
if analyticsSecretPath == DefaultAnalyticsSecretPath {
// allows fall back to default credentials or fluentd if the path is the default one
log.Warnf("analytics service account credentials not found on default path, falling back to credentials from config file")
} else {
// returns error if the invalid path is explicitly specified
return err
}
} else {
// overwrites the credentials if read from the config
c.Analytics.CredentialsJSON = sa
c.Analytics.Credentials, err = google.CredentialsFromJSON(context.Background(), sa, ApigeeAPIScope)
if err != nil {
return err
}
}
}
}
return c.Validate(requireAnalyticsCredentials)
}
// IsGCPManaged is true for hybrid and NG SaaS
func (c *Config) IsGCPManaged() bool {
return c.Tenant.InternalAPI == ""
}
// IsApigeeManaged is true for legacy SaaS
func (c *Config) IsApigeeManaged() bool {
return c.Tenant.InternalAPI == LegacySaaSInternalBase
}
// IsOPDK is true for OPDK installs
func (c *Config) IsOPDK() bool {
return !c.IsGCPManaged() && !c.IsApigeeManaged()
}
// Validate validates the config
func (c *Config) Validate(requireAnalyticsCredentials bool) error {
var errs error
if c.Tenant.RemoteServiceAPI == "" {
errs = multierror.Append(errs, fmt.Errorf("tenant.remote_service_api is required"))
}
if len(c.Analytics.CredentialsJSON) == 0 {
if c.Tenant.InternalAPI == "" && c.Analytics.FluentdEndpoint == "" && requireAnalyticsCredentials {
cred, err := google.FindDefaultCredentials(context.Background(), ApigeeAPIScope)
if err != nil {
errs = multierror.Append(errs, fmt.Errorf("tenant.internal_api or tenant.analytics.fluentd_endpoint is required if analytics credentials not given"))
} else { // to avoid the non-name error
c.Analytics.Credentials = cred
}
}
} else {
if c.Tenant.InternalAPI != "" {
errs = multierror.Append(errs, fmt.Errorf("tenant.internal_api and analytics credentials are mutually exclusive"))
}
}
if c.Tenant.OrgName == "" {
errs = multierror.Append(errs, fmt.Errorf("tenant.org_name is required"))
}
if c.Tenant.EnvName == "" {
errs = multierror.Append(errs, fmt.Errorf("tenant.env_name is required"))
}
if (c.Global.TLS.CertFile != "" || c.Global.TLS.KeyFile != "") &&
(c.Global.TLS.CertFile == "" || c.Global.TLS.KeyFile == "") {
errs = multierror.Append(errs, fmt.Errorf("global.tls.cert_file and global.tls.key_file are both required if either are present"))
}
if (c.Analytics.TLS.CAFile != "" || c.Analytics.TLS.CertFile != "" || c.Analytics.TLS.KeyFile != "") &&
(c.Analytics.TLS.CAFile == "" || c.Analytics.TLS.CertFile == "" || c.Analytics.TLS.KeyFile == "") {
errs = multierror.Append(errs, fmt.Errorf("all analytics.tls options are required if any are present"))
}
return errs
}
// ConfigMapCRD is a CRD for ConfigMap
type ConfigMapCRD struct {
APIVersion string `yaml:"apiVersion"`
Kind string `yaml:"kind"`
Metadata Metadata `yaml:"metadata"`
Data map[string]string `yaml:"data"`
}
// SecretCRD is a CRD for Secret
type SecretCRD struct {
APIVersion string `yaml:"apiVersion"`
Kind string `yaml:"kind"`
Metadata Metadata `yaml:"metadata"`
Type string `yaml:"type,omitempty"`
Data map[string]string `yaml:"data"`
}
// Metadata is for Kubernetes CRD generation
type Metadata struct {
Name string `yaml:"name"`
Namespace string `yaml:"namespace"`
}
// note: hybrid forces these specific file extensions! https://docs.apigee.com/hybrid/v1.2/k8s-secrets
const (
SecretJWKSKey = "remote-service.crt" // hybrid treats .crt as blob
SecretPrivateKey = "remote-service.key" // private key
SecretPropsKey = "remote-service.properties" // java properties format: %s=%s
SecretPropsKIDKey = "kid"
)