-
Notifications
You must be signed in to change notification settings - Fork 777
/
local_store_tls_provider.go
502 lines (430 loc) · 15.2 KB
/
local_store_tls_provider.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
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package encryption
import (
"crypto/tls"
"crypto/x509"
"fmt"
"sync"
"time"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/auth"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/log"
)
type CertProviderFactory func(
tlsSettings *config.GroupTLS,
workerTlsSettings *config.WorkerTLS,
legacyWorkerSettings *config.ClientTLS,
refreshInterval time.Duration,
logger log.Logger) CertProvider
type localStoreTlsProvider struct {
sync.RWMutex
settings *config.RootTLS
internodeCertProvider CertProvider
internodeClientCertProvider CertProvider
frontendCertProvider CertProvider
workerCertProvider CertProvider
remoteClusterClientCertProvider map[string]CertProvider
frontendPerHostCertProviderMap *localStorePerHostCertProviderMap
cachedInternodeServerConfig *tls.Config
cachedInternodeClientConfig *tls.Config
cachedFrontendServerConfig *tls.Config
cachedFrontendClientConfig *tls.Config
cachedRemoteClusterClientConfig map[string]*tls.Config
ticker *time.Ticker
logger log.Logger
stop chan bool
metricsHandler metrics.Handler
}
var _ TLSConfigProvider = (*localStoreTlsProvider)(nil)
var _ CertExpirationChecker = (*localStoreTlsProvider)(nil)
func NewLocalStoreTlsProvider(tlsConfig *config.RootTLS, metricsHandler metrics.Handler, logger log.Logger, certProviderFactory CertProviderFactory,
) (TLSConfigProvider, error) {
internodeProvider := certProviderFactory(&tlsConfig.Internode, nil, nil, tlsConfig.RefreshInterval, logger)
var workerProvider CertProvider
if isSystemWorker(tlsConfig) { // explicit system worker config
workerProvider = certProviderFactory(nil, &tlsConfig.SystemWorker, nil, tlsConfig.RefreshInterval, logger)
} else { // legacy implicit system worker config case
internodeWorkerProvider := certProviderFactory(&tlsConfig.Internode, nil, &tlsConfig.Frontend.Client, tlsConfig.RefreshInterval, logger)
workerProvider = internodeWorkerProvider
}
remoteClusterClientCertProvider := make(map[string]CertProvider)
for hostname, groupTLS := range tlsConfig.RemoteClusters {
remoteClusterClientCertProvider[hostname] = certProviderFactory(&groupTLS, nil, nil, tlsConfig.RefreshInterval, logger)
}
provider := &localStoreTlsProvider{
internodeCertProvider: internodeProvider,
internodeClientCertProvider: internodeProvider,
frontendCertProvider: certProviderFactory(&tlsConfig.Frontend, nil, nil, tlsConfig.RefreshInterval, logger),
workerCertProvider: workerProvider,
frontendPerHostCertProviderMap: newLocalStorePerHostCertProviderMap(
tlsConfig.Frontend.PerHostOverrides, certProviderFactory, tlsConfig.RefreshInterval, logger),
remoteClusterClientCertProvider: remoteClusterClientCertProvider,
RWMutex: sync.RWMutex{},
settings: tlsConfig,
metricsHandler: metricsHandler,
logger: logger,
cachedRemoteClusterClientConfig: make(map[string]*tls.Config),
}
provider.initialize()
return provider, nil
}
func (s *localStoreTlsProvider) initialize() {
period := s.settings.ExpirationChecks.CheckInterval
if period != 0 {
s.stop = make(chan bool)
s.ticker = time.NewTicker(period)
s.checkCertExpiration() // perform initial check to emit metrics and logs right away
go s.timerCallback()
}
}
func (s *localStoreTlsProvider) Close() {
if s.ticker != nil {
s.ticker.Stop()
}
if s.stop != nil {
s.stop <- true
close(s.stop)
}
}
func (s *localStoreTlsProvider) GetInternodeClientConfig() (*tls.Config, error) {
client := &s.settings.Internode.Client
return s.getOrCreateConfig(
&s.cachedInternodeClientConfig,
func() (*tls.Config, error) {
return newClientTLSConfig(s.internodeClientCertProvider, client.ServerName,
s.settings.Internode.Server.RequireClientAuth, false, !client.DisableHostVerification)
},
s.settings.Internode.IsClientEnabled(),
)
}
func (s *localStoreTlsProvider) GetFrontendClientConfig() (*tls.Config, error) {
var client *config.ClientTLS
var useTLS bool
if isSystemWorker(s.settings) {
client = &s.settings.SystemWorker.Client
useTLS = true
} else {
client = &s.settings.Frontend.Client
useTLS = s.settings.Frontend.IsClientEnabled()
}
return s.getOrCreateConfig(
&s.cachedFrontendClientConfig,
func() (*tls.Config, error) {
return newClientTLSConfig(s.workerCertProvider, client.ServerName,
useTLS, true, !client.DisableHostVerification)
},
useTLS,
)
}
func (s *localStoreTlsProvider) GetRemoteClusterClientConfig(hostname string) (*tls.Config, error) {
groupTLS, ok := s.settings.RemoteClusters[hostname]
if !ok {
return nil, nil
}
return s.getOrCreateRemoteClusterClientConfig(
hostname,
func() (*tls.Config, error) {
return newClientTLSConfig(
s.remoteClusterClientCertProvider[hostname],
groupTLS.Client.ServerName,
groupTLS.Server.RequireClientAuth,
false,
!groupTLS.Client.DisableHostVerification)
},
groupTLS.IsClientEnabled(),
)
}
func (s *localStoreTlsProvider) GetFrontendServerConfig() (*tls.Config, error) {
return s.getOrCreateConfig(
&s.cachedFrontendServerConfig,
func() (*tls.Config, error) {
return newServerTLSConfig(s.frontendCertProvider, s.frontendPerHostCertProviderMap, &s.settings.Frontend, s.logger)
},
s.settings.Frontend.IsServerEnabled())
}
func (s *localStoreTlsProvider) GetInternodeServerConfig() (*tls.Config, error) {
return s.getOrCreateConfig(
&s.cachedInternodeServerConfig,
func() (*tls.Config, error) {
return newServerTLSConfig(s.internodeCertProvider, nil, &s.settings.Internode, s.logger)
},
s.settings.Internode.IsServerEnabled())
}
func (s *localStoreTlsProvider) GetExpiringCerts(timeWindow time.Duration,
) (expiring CertExpirationMap, expired CertExpirationMap, err error) {
expiring = make(CertExpirationMap, 0)
expired = make(CertExpirationMap, 0)
checkError := checkExpiration(s.internodeCertProvider, timeWindow, expiring, expired)
err = appendError(err, checkError)
checkError = checkExpiration(s.frontendCertProvider, timeWindow, expiring, expired)
err = appendError(err, checkError)
checkError = checkExpiration(s.workerCertProvider, timeWindow, expiring, expired)
err = appendError(err, checkError)
checkError = checkExpiration(s.frontendPerHostCertProviderMap, timeWindow, expiring, expired)
err = appendError(err, checkError)
return expiring, expired, err
}
func checkExpiration(
provider CertExpirationChecker,
timeWindow time.Duration,
expiring CertExpirationMap,
expired CertExpirationMap,
) error {
providerExpiring, providerExpired, err := provider.GetExpiringCerts(timeWindow)
mergeMaps(expiring, providerExpiring)
mergeMaps(expired, providerExpired)
return err
}
func (s *localStoreTlsProvider) getOrCreateConfig(
cachedConfig **tls.Config,
configConstructor tlsConfigConstructor,
isEnabled bool,
) (*tls.Config, error) {
if !isEnabled {
return nil, nil
}
// Check if exists under a read lock first
s.RLock()
if *cachedConfig != nil {
defer s.RUnlock()
return *cachedConfig, nil
}
// Not found, promote to write lock to initialize
s.RUnlock()
s.Lock()
defer s.Unlock()
// Check if someone got here first while waiting for write lock
if *cachedConfig != nil {
return *cachedConfig, nil
}
// Load configuration
localConfig, err := configConstructor()
if err != nil {
return nil, err
}
*cachedConfig = localConfig
return *cachedConfig, nil
}
func (s *localStoreTlsProvider) getOrCreateRemoteClusterClientConfig(
hostname string,
configConstructor tlsConfigConstructor,
isEnabled bool,
) (*tls.Config, error) {
if !isEnabled {
return nil, nil
}
// Check if exists under a read lock first
s.RLock()
if clientConfig, ok := s.cachedRemoteClusterClientConfig[hostname]; ok {
defer s.RUnlock()
return clientConfig, nil
}
// Not found, promote to write lock to initialize
s.RUnlock()
s.Lock()
defer s.Unlock()
// Check if someone got here first while waiting for write lock
if clientConfig, ok := s.cachedRemoteClusterClientConfig[hostname]; ok {
return clientConfig, nil
}
// Load configuration
localConfig, err := configConstructor()
if err != nil {
return nil, err
}
s.cachedRemoteClusterClientConfig[hostname] = localConfig
return localConfig, nil
}
func newServerTLSConfig(
certProvider CertProvider,
perHostCertProviderMap PerHostCertProviderMap,
config *config.GroupTLS,
logger log.Logger,
) (*tls.Config, error) {
clientAuthRequired := config.Server.RequireClientAuth
tlsConfig, err := getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, "", "", logger)
if err != nil {
return nil, err
}
tlsConfig.GetConfigForClient = func(c *tls.ClientHelloInfo) (*tls.Config, error) {
remoteAddress := c.Conn.RemoteAddr().String()
logger.Debug("attempted incoming TLS connection", tag.Address(remoteAddress), tag.ServerName(c.ServerName))
if perHostCertProviderMap != nil && perHostCertProviderMap.NumberOfHosts() > 0 {
perHostCertProvider, hostClientAuthRequired, err := perHostCertProviderMap.GetCertProvider(c.ServerName)
if err != nil {
logger.Error("error while looking up per-host provider for attempted incoming TLS connection",
tag.ServerName(c.ServerName), tag.Address(remoteAddress), tag.Error(err))
return nil, err
}
if perHostCertProvider != nil {
return getServerTLSConfigFromCertProvider(perHostCertProvider, hostClientAuthRequired, remoteAddress, c.ServerName, logger)
}
logger.Warn("cannot find a per-host provider for attempted incoming TLS connection. returning default TLS configuration",
tag.ServerName(c.ServerName), tag.Address(remoteAddress))
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, remoteAddress, c.ServerName, logger)
}
return getServerTLSConfigFromCertProvider(certProvider, clientAuthRequired, remoteAddress, c.ServerName, logger)
}
return tlsConfig, nil
}
func getServerTLSConfigFromCertProvider(
certProvider CertProvider,
requireClientAuth bool,
remoteAddress string,
serverName string,
logger log.Logger) (*tls.Config, error) {
// Get serverCert from disk
serverCert, err := certProvider.FetchServerCertificate()
if err != nil {
return nil, fmt.Errorf("loading server tls certificate failed: %v", err)
}
// tls disabled, responsibility of cert provider above to error otherwise
if serverCert == nil {
return nil, nil
}
// Default to NoClientAuth
clientAuthType := tls.NoClientCert
var clientCaPool *x509.CertPool
// If mTLS enabled
if requireClientAuth {
clientAuthType = tls.RequireAndVerifyClientCert
ca, err := certProvider.FetchClientCAs()
if err != nil {
return nil, fmt.Errorf("failed to fetch client CAs: %v", err)
}
clientCaPool = ca
}
if remoteAddress != "" { // remoteAddress=="" when we return initial tls.Config object when configuring server
logger.Debug("returning TLS config for connection", tag.Address(remoteAddress), tag.ServerName(serverName))
}
return auth.NewTLSConfigWithCertsAndCAs(
clientAuthType,
[]tls.Certificate{*serverCert},
clientCaPool,
logger), nil
}
func newClientTLSConfig(
clientProvider CertProvider,
serverName string,
isAuthRequired bool,
isWorker bool,
enableHostVerification bool,
) (*tls.Config, error) {
// Optional ServerCA for client if not already trusted by host
serverCa, err := clientProvider.FetchServerRootCAsForClient(isWorker)
if err != nil {
return nil, fmt.Errorf("failed to load client ca: %v", err)
}
var getCert tlsCertFetcher
// mTLS enabled, present certificate
if isAuthRequired {
getCert = func() (*tls.Certificate, error) {
cert, err := clientProvider.FetchClientCertificate(isWorker)
if err != nil {
return nil, err
}
if cert == nil {
return nil, fmt.Errorf("client auth required, but no certificate provided")
}
return cert, nil
}
}
return auth.NewDynamicTLSClientConfig(
getCert,
serverCa,
serverName,
enableHostVerification,
), nil
}
func (s *localStoreTlsProvider) timerCallback() {
for {
select {
case <-s.stop:
return
case <-s.ticker.C:
}
s.checkCertExpiration()
}
}
func (s *localStoreTlsProvider) checkCertExpiration() {
var retError error
defer log.CapturePanic(s.logger, &retError)
var errorTime time.Time
if s.settings.ExpirationChecks.ErrorWindow != 0 {
errorTime = time.Now().UTC().Add(s.settings.ExpirationChecks.ErrorWindow)
} else {
errorTime = time.Now().UTC().AddDate(10, 0, 0)
}
window := s.settings.ExpirationChecks.WarningWindow
// if only ErrorWindow is set, we set WarningWindow to the same value, so that the checks do happen
if window == 0 && s.settings.ExpirationChecks.ErrorWindow != 0 {
window = s.settings.ExpirationChecks.ErrorWindow
}
if window != 0 {
expiring, expired, err := s.GetExpiringCerts(window)
if err != nil {
s.logger.Error(fmt.Sprintf("error while checking for certificate expiration: %v", err))
return
}
if s.metricsHandler != nil {
metrics.TlsCertsExpired.With(s.metricsHandler).Record(float64(len(expired)))
metrics.TlsCertsExpiring.With(s.metricsHandler).Record(float64(len(expiring)))
}
s.logCerts(expired, true, errorTime)
s.logCerts(expiring, false, errorTime)
}
}
func (s *localStoreTlsProvider) logCerts(certs CertExpirationMap, expired bool, errorTime time.Time) {
for _, cert := range certs {
str := createExpirationLogMessage(cert, expired)
if expired || cert.Expiration.Before(errorTime) {
s.logger.Error(str)
} else {
s.logger.Warn(str)
}
}
}
func createExpirationLogMessage(cert CertExpirationData, expired bool) string {
var verb string
if expired {
verb = "has expired"
} else {
verb = "will expire"
}
return fmt.Sprintf("certificate with thumbprint=%x %s on %v, IsCA=%t, DNS=%v",
cert.Thumbprint, verb, cert.Expiration, cert.IsCA, cert.DNSNames)
}
func mergeMaps(to CertExpirationMap, from CertExpirationMap) {
for k, v := range from {
to[k] = v
}
}
func isSystemWorker(tls *config.RootTLS) bool {
return tls.SystemWorker.CertData != "" || tls.SystemWorker.CertFile != "" ||
len(tls.SystemWorker.Client.RootCAData) > 0 || len(tls.SystemWorker.Client.RootCAFiles) > 0 ||
tls.SystemWorker.Client.ForceTLS
}