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
|
// Copyright 2018 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.athenz.instanceproviderservice;
import com.google.inject.Inject;
import com.yahoo.cloud.config.ConfigserverConfig;
import com.yahoo.component.AbstractComponent;
import com.yahoo.config.provision.Zone;
import com.yahoo.jdisc.http.ssl.SslKeyStoreConfigurator;
import com.yahoo.jdisc.http.ssl.SslKeyStoreContext;
import com.yahoo.log.LogLevel;
import com.yahoo.vespa.athenz.identity.ServiceIdentityProvider;
import com.yahoo.vespa.athenz.tls.KeyStoreBuilder;
import com.yahoo.vespa.athenz.tls.KeyStoreType;
import com.yahoo.vespa.defaults.Defaults;
import com.yahoo.vespa.hosted.athenz.instanceproviderservice.config.AthenzProviderServiceConfig;
import com.yahoo.vespa.hosted.athenz.instanceproviderservice.impl.AthenzCertificateClient;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.security.GeneralSecurityException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.PrivateKey;
import java.security.cert.X509Certificate;
import java.time.Duration;
import java.time.Instant;
import java.util.Optional;
import java.util.UUID;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
import static com.yahoo.vespa.athenz.tls.KeyStoreUtils.writeKeyStoreToFile;
import static com.yahoo.vespa.hosted.athenz.instanceproviderservice.impl.Utils.getZoneConfig;
/**
* A component that is responsible for retrieving an Athenz TLS certificate and configuring the configserver to use
* that certificate for its HTTPS endpoint.
*
* @author bjorncs
*/
@SuppressWarnings("unused") // Component injected into Jetty connector factory
public class AthenzSslKeyStoreConfigurator extends AbstractComponent implements SslKeyStoreConfigurator {
private static final Logger log = Logger.getLogger(AthenzSslKeyStoreConfigurator.class.getName());
private static final String CERTIFICATE_ALIAS = "athenz";
private static final Duration EXPIRATION_MARGIN = Duration.ofHours(6);
private final ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor();
private final AthenzCertificateClient certificateClient;
private final KeyProvider keyProvider;
private final AthenzProviderServiceConfig.Zones zoneConfig;
private final Duration updatePeriod;
private final Path keystoreDirectory;
private volatile KeyStoreAndPassword currentKeyStore;
@Inject
public AthenzSslKeyStoreConfigurator(ServiceIdentityProvider bootstrapIdentity,
KeyProvider keyProvider,
AthenzProviderServiceConfig config,
Zone zone,
ConfigserverConfig configserverConfig) {
AthenzProviderServiceConfig.Zones zoneConfig = getZoneConfig(config, zone);
Path keystoreDirectory = createKeystoreCacheDirectory(configserverConfig);
AthenzCertificateClient certificateClient = new AthenzCertificateClient(bootstrapIdentity, zoneConfig);
Duration updatePeriod = Duration.ofDays(config.updatePeriodDays());
this.certificateClient = certificateClient;
this.keyProvider = keyProvider;
this.zoneConfig = zoneConfig;
this.currentKeyStore = initializeKeystore(keyProvider, certificateClient, zoneConfig, keystoreDirectory, updatePeriod);
this.updatePeriod = updatePeriod;
this.keystoreDirectory = keystoreDirectory;
}
private static KeyStoreAndPassword initializeKeystore(KeyProvider keyProvider,
AthenzCertificateClient certificateClient,
AthenzProviderServiceConfig.Zones zoneConfig,
Path keystoreCacheDirectory,
Duration updatePeriod) {
return tryReadKeystoreFile(keystoreCacheDirectory, updatePeriod)
.orElseGet(() -> downloadCertificate(keyProvider, certificateClient, zoneConfig, keystoreCacheDirectory));
}
private static Optional<KeyStoreAndPassword> tryReadKeystoreFile(Path keystoreDirectory, Duration updatePeriod) {
try {
Path keystoreFile = keystoreFile(keystoreDirectory);
Path keystoreSecretFile = keystoreSecretFile(keystoreDirectory);
if (!Files.exists(keystoreFile) || !Files.exists(keystoreSecretFile)) return Optional.empty();
KeyStore keyStore = KeyStoreBuilder.withType(KeyStoreType.JKS)
.fromFile(keystoreFile.toFile())
.build();
Instant minimumExpiration = Instant.now().plus(updatePeriod).plus(EXPIRATION_MARGIN);
boolean isExpired = getCertificateExpiry(keyStore).isBefore(minimumExpiration);
if (isExpired) return Optional.empty();
char[] pwd = new String(Files.readAllBytes(keystoreSecretFile)).toCharArray();
return Optional.of(new KeyStoreAndPassword(keyStore, pwd));
} catch (GeneralSecurityException | IOException e) {
log.log(LogLevel.ERROR, "Failed to read keystore from disk: " + e.getMessage(), e);
return Optional.empty();
}
}
private static Path createKeystoreCacheDirectory(ConfigserverConfig configserverConfig) {
return Paths.get(Defaults.getDefaults().underVespaHome(configserverConfig.configServerDBDir()));
}
private static Path keystoreFile(Path keystoreDirectory) {
return keystoreDirectory.resolve("server-x509-athenz-cert.jks");
}
private static Path keystoreSecretFile(Path keystoreDirectory) {
return keystoreDirectory.resolve("keystore-secret");
}
@Override
public void configure(SslKeyStoreContext sslKeyStoreContext) {
sslKeyStoreContext.updateKeyStore(currentKeyStore.keyStore, new String(currentKeyStore.password));
scheduler.scheduleAtFixedRate(new AthenzCertificateUpdater(sslKeyStoreContext),
updatePeriod.toDays()/*initial delay*/,
updatePeriod.toDays(),
TimeUnit.DAYS);
}
@Override
public void deconstruct() {
try {
scheduler.shutdownNow();
scheduler.awaitTermination(30, TimeUnit.SECONDS);
} catch (InterruptedException e) {
throw new RuntimeException("Failed to shutdown Athenz certificate updater on time", e);
}
}
Instant getCertificateExpiry() throws KeyStoreException {
return getCertificateExpiry(currentKeyStore.keyStore);
}
private static Instant getCertificateExpiry(KeyStore keyStore) throws KeyStoreException {
X509Certificate certificate = (X509Certificate) keyStore.getCertificate(CERTIFICATE_ALIAS);
return certificate.getNotAfter().toInstant();
}
private static KeyStoreAndPassword downloadCertificate(KeyProvider keyProvider,
AthenzCertificateClient certificateClient,
AthenzProviderServiceConfig.Zones zoneConfig,
Path keystoreDirectory) {
PrivateKey privateKey = keyProvider.getPrivateKey(zoneConfig.secretVersion());
X509Certificate certificate = certificateClient.updateCertificate(privateKey);
Instant expirationTime = certificate.getNotAfter().toInstant();
Duration expiry = Duration.between(certificate.getNotBefore().toInstant(), expirationTime);
log.log(LogLevel.INFO, String.format("Got Athenz x509 certificate with expiry %s (expires %s)", expiry, expirationTime));
char[] keystorePassword = generateKeystorePassword();
KeyStore keyStore = KeyStoreBuilder.withType(KeyStoreType.JKS)
.withKeyEntry(CERTIFICATE_ALIAS, privateKey, keystorePassword, certificate)
.build();
KeyStoreAndPassword keyStoreAndPassword = new KeyStoreAndPassword(keyStore, keystorePassword);
tryWriteKeystore(keyStoreAndPassword, keystoreDirectory);
return keyStoreAndPassword;
}
private static void tryWriteKeystore(KeyStoreAndPassword keyStore, Path keystoreDirectory) {
try {
writeKeyStoreToFile(keyStore.keyStore, keystoreFile(keystoreDirectory).toFile());
Files.write(keystoreSecretFile(keystoreDirectory), new String(keyStore.password).getBytes());
} catch (Exception e) {
log.log(LogLevel.ERROR, "Failed to write keystore to disk: " + e.getMessage(), e);
}
}
private static char[] generateKeystorePassword() {
return UUID.randomUUID().toString().toCharArray();
}
private class AthenzCertificateUpdater implements Runnable {
private final SslKeyStoreContext sslKeyStoreContext;
AthenzCertificateUpdater(SslKeyStoreContext sslKeyStoreContext) {
this.sslKeyStoreContext = sslKeyStoreContext;
}
@Override
public void run() {
try {
log.log(LogLevel.INFO, "Updating Athenz certificate from ZTS");
currentKeyStore = downloadCertificate(keyProvider, certificateClient, zoneConfig, keystoreDirectory);
sslKeyStoreContext.updateKeyStore(currentKeyStore.keyStore, new String(currentKeyStore.password));
log.log(LogLevel.INFO, "Athenz certificate reload successfully completed");
} catch (Throwable e) {
log.log(LogLevel.ERROR, "Failed to update certificate from ZTS: " + e.getMessage(), e);
}
}
}
private static class KeyStoreAndPassword {
final KeyStore keyStore;
final char[] password;
KeyStoreAndPassword(KeyStore keyStore, char[] password) {
this.keyStore = keyStore;
this.password = password;
}
}
}
|
