-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Introduce ssl settings to reindex from remote #37527
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
4a5781c
Introduce ssl settings to reindex from remote
tvernum bffcdde
Make field final
tvernum 7ab750b
Revert whitespace changes
tvernum 9418c68
Switch to use project substitutioni
tvernum 00ce76e
Merge branch 'master' into reindex-ssl-lib/2
tvernum 370ec35
Merge branch 'master' into reindex-ssl-lib/2
tvernum d50ea50
Merge branch 'master' into reindex-ssl-lib/2
tvernum 475394c
Merge branch 'master' into reindex-ssl-lib/2
tvernum ca801cd
Merge branch 'master' into reindex-ssl-lib/2
tvernum 01570ab
Merge branch 'master' into reindex-ssl-lib/2
tvernum 3431c45
Merge branch 'master' into reindex-ssl-lib/2
tvernum b1dc890
Merge branch 'master' into reindex-ssl-lib/2
tvernum aef8015
Merge branch 'master' into reindex-ssl-lib/2
tvernum File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
161 changes: 161 additions & 0 deletions
161
modules/reindex/src/main/java/org/elasticsearch/index/reindex/ReindexSslConfig.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.index.reindex; | ||
|
||
import org.apache.http.conn.ssl.DefaultHostnameVerifier; | ||
import org.apache.http.conn.ssl.NoopHostnameVerifier; | ||
import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; | ||
import org.elasticsearch.common.Strings; | ||
import org.elasticsearch.common.settings.SecureSetting; | ||
import org.elasticsearch.common.settings.SecureString; | ||
import org.elasticsearch.common.settings.Setting; | ||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.common.ssl.SslConfiguration; | ||
import org.elasticsearch.common.ssl.SslConfigurationKeys; | ||
import org.elasticsearch.common.ssl.SslConfigurationLoader; | ||
import org.elasticsearch.env.Environment; | ||
import org.elasticsearch.watcher.FileChangesListener; | ||
import org.elasticsearch.watcher.FileWatcher; | ||
import org.elasticsearch.watcher.ResourceWatcherService; | ||
|
||
import javax.net.ssl.HostnameVerifier; | ||
import javax.net.ssl.SSLContext; | ||
import java.io.IOException; | ||
import java.io.UncheckedIOException; | ||
import java.nio.file.Path; | ||
import java.util.ArrayList; | ||
import java.util.Collections; | ||
import java.util.HashMap; | ||
import java.util.List; | ||
import java.util.Map; | ||
import java.util.function.Function; | ||
|
||
import static org.elasticsearch.common.settings.Setting.listSetting; | ||
import static org.elasticsearch.common.settings.Setting.simpleString; | ||
|
||
/** | ||
* Loads "reindex.ssl.*" configuration from Settings, and makes the applicable configuration (trust manager / key manager / hostname | ||
* verification / cipher-suites) available for reindex-from-remote. | ||
*/ | ||
class ReindexSslConfig { | ||
|
||
private static final Map<String, Setting<?>> SETTINGS = new HashMap<>(); | ||
private static final Map<String, Setting<SecureString>> SECURE_SETTINGS = new HashMap<>(); | ||
|
||
static { | ||
Setting.Property[] defaultProperties = new Setting.Property[] { Setting.Property.NodeScope, Setting.Property.Filtered }; | ||
Setting.Property[] deprecatedProperties = new Setting.Property[] { Setting.Property.Deprecated, Setting.Property.NodeScope, | ||
Setting.Property.Filtered }; | ||
for (String key : SslConfigurationKeys.getStringKeys()) { | ||
String settingName = "reindex.ssl." + key; | ||
final Setting.Property[] properties = SslConfigurationKeys.isDeprecated(key) ? deprecatedProperties : defaultProperties; | ||
SETTINGS.put(settingName, simpleString(settingName, properties)); | ||
} | ||
for (String key : SslConfigurationKeys.getListKeys()) { | ||
String settingName = "reindex.ssl." + key; | ||
final Setting.Property[] properties = SslConfigurationKeys.isDeprecated(key) ? deprecatedProperties : defaultProperties; | ||
SETTINGS.put(settingName, listSetting(settingName, Collections.emptyList(), Function.identity(), properties)); | ||
} | ||
for (String key : SslConfigurationKeys.getSecureStringKeys()) { | ||
String settingName = "reindex.ssl." + key; | ||
SECURE_SETTINGS.put(settingName, SecureSetting.secureString(settingName, null)); | ||
} | ||
} | ||
|
||
private final SslConfiguration configuration; | ||
private volatile SSLContext context; | ||
|
||
public static List<Setting<?>> getSettings() { | ||
List<Setting<?>> settings = new ArrayList<>(); | ||
settings.addAll(SETTINGS.values()); | ||
settings.addAll(SECURE_SETTINGS.values()); | ||
return settings; | ||
} | ||
|
||
ReindexSslConfig(Settings settings, Environment environment, ResourceWatcherService resourceWatcher) { | ||
final SslConfigurationLoader loader = new SslConfigurationLoader("reindex.ssl.") { | ||
|
||
@Override | ||
protected String getSettingAsString(String key) { | ||
return settings.get(key); | ||
} | ||
|
||
@Override | ||
protected char[] getSecureSetting(String key) { | ||
final Setting<SecureString> setting = SECURE_SETTINGS.get(key); | ||
if (setting == null) { | ||
throw new IllegalArgumentException("The secure setting [" + key + "] is not registered"); | ||
} | ||
return setting.get(settings).getChars(); | ||
} | ||
|
||
@Override | ||
protected List<String> getSettingAsList(String key) throws Exception { | ||
return settings.getAsList(key); | ||
} | ||
}; | ||
configuration = loader.load(environment.configFile()); | ||
reload(); | ||
|
||
final FileChangesListener listener = new FileChangesListener() { | ||
@Override | ||
public void onFileCreated(Path file) { | ||
onFileChanged(file); | ||
} | ||
|
||
@Override | ||
public void onFileDeleted(Path file) { | ||
onFileChanged(file); | ||
} | ||
|
||
@Override | ||
public void onFileChanged(Path file) { | ||
ReindexSslConfig.this.reload(); | ||
} | ||
}; | ||
for (Path file : configuration.getDependentFiles()) { | ||
try { | ||
final FileWatcher watcher = new FileWatcher(file); | ||
watcher.addListener(listener); | ||
resourceWatcher.add(watcher, ResourceWatcherService.Frequency.HIGH); | ||
} catch (IOException e) { | ||
throw new UncheckedIOException("cannot watch file [" + file + "]", e); | ||
} | ||
} | ||
} | ||
|
||
private void reload() { | ||
this.context = configuration.createSslContext(); | ||
} | ||
|
||
/** | ||
* Encapsulate the loaded SSL configuration as a HTTP-client {@link SSLIOSessionStrategy}. | ||
* The returned strategy is immutable, but successive calls will return different objects that may have different | ||
* configurations if the underlying key/certificate files are modified. | ||
*/ | ||
SSLIOSessionStrategy getStrategy() { | ||
final HostnameVerifier hostnameVerifier = configuration.getVerificationMode().isHostnameVerificationEnabled() | ||
? new DefaultHostnameVerifier() | ||
: new NoopHostnameVerifier(); | ||
final String[] protocols = configuration.getSupportedProtocols().toArray(Strings.EMPTY_ARRAY); | ||
final String[] cipherSuites = configuration.getCipherSuites().toArray(Strings.EMPTY_ARRAY); | ||
return new SSLIOSessionStrategy(context, protocols, cipherSuites, hostnameVerifier); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The introduction of the
Action
as a generic type parameter and field (mainAction
below) is an attempt to solve the problems that come from the wayAbstractAsyncBulkByScrollAction
callsbuildScrollableResultSource
from its constructor.Because the call is made from the superclass's constructor, it means that
TransportReindexAction.AsyncIndexBySearchAction.buildScrollableResultSource
(and by extensionbuildRestClient
) can't make use of any fields in the subclass.But
buildRestClient
needs access to theReindexSslConfig
instance, so we either need to push that up into the base class, or come up with a different approach.By pushing a generic
mainAction
up into the base class, we can access fields from theAction
without needing to duplicate them inAbstractAsyncBulkByScrollAction
. This allows us to also removescriptService
from this class.