-
Notifications
You must be signed in to change notification settings - Fork 25k
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
[ML] prefer secondary auth headers on data frame analytics _explain #63281
Merged
benwtrent
merged 2 commits into
elastic:master
from
benwtrent:feature/ml-use-secondary-headers-on-explain
Oct 6, 2020
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
196 changes: 196 additions & 0 deletions
196
...RestTest/java/org/elasticsearch/xpack/ml/integration/ExplainDataFrameAnalyticsRestIT.java
This file contains 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,196 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
| package org.elasticsearch.xpack.ml.integration; | ||
|
|
||
| import org.apache.http.util.EntityUtils; | ||
| import org.elasticsearch.client.Request; | ||
| import org.elasticsearch.client.RequestOptions; | ||
| import org.elasticsearch.client.ResponseException; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.common.util.concurrent.ThreadContext; | ||
| import org.elasticsearch.test.SecuritySettingsSourceField; | ||
| import org.elasticsearch.test.rest.ESRestTestCase; | ||
| import org.elasticsearch.xpack.core.security.authc.support.UsernamePasswordToken; | ||
| import org.junit.Before; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static org.hamcrest.Matchers.containsString; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.not; | ||
|
|
||
| public class ExplainDataFrameAnalyticsRestIT extends ESRestTestCase { | ||
|
|
||
| private static String basicAuth(String user) { | ||
| return UsernamePasswordToken.basicAuthHeaderValue(user, SecuritySettingsSourceField.TEST_PASSWORD_SECURE_STRING); | ||
| } | ||
benwtrent marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private static final String SUPER_USER = "x_pack_rest_user"; | ||
| private static final String ML_ADMIN = "ml_admin"; | ||
| private static final String BASIC_AUTH_VALUE_SUPER_USER = basicAuth(SUPER_USER); | ||
| private static final String AUTH_KEY = "Authorization"; | ||
| private static final String SECONDARY_AUTH_KEY = "es-secondary-authorization"; | ||
|
|
||
| private static RequestOptions.Builder addAuthHeader(RequestOptions.Builder builder, String user) { | ||
| builder.addHeader(AUTH_KEY, basicAuth(user)); | ||
| return builder; | ||
| } | ||
|
|
||
| private static RequestOptions.Builder addSecondaryAuthHeader(RequestOptions.Builder builder, String user) { | ||
| builder.addHeader(SECONDARY_AUTH_KEY, basicAuth(user)); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| protected Settings restClientSettings() { | ||
| return Settings.builder().put(ThreadContext.PREFIX + ".Authorization", BASIC_AUTH_VALUE_SUPER_USER).build(); | ||
| } | ||
|
|
||
| private void setupUser(String user, List<String> roles) throws IOException { | ||
| String password = new String(SecuritySettingsSourceField.TEST_PASSWORD_SECURE_STRING.getChars()); | ||
|
|
||
| Request request = new Request("PUT", "/_security/user/" + user); | ||
| request.setJsonEntity("{" | ||
| + " \"password\" : \"" + password + "\"," | ||
| + " \"roles\" : [ " + roles.stream().map(unquoted -> "\"" + unquoted + "\"").collect(Collectors.joining(", ")) + " ]" | ||
| + "}"); | ||
| client().performRequest(request); | ||
| } | ||
|
|
||
| @Before | ||
| public void setUpData() throws Exception { | ||
| // This user has admin rights on machine learning, but (importantly for the tests) no rights | ||
| // on any of the data indexes | ||
| setupUser(ML_ADMIN, Collections.singletonList("machine_learning_admin")); | ||
| addAirlineData(); | ||
| } | ||
|
|
||
| private void addAirlineData() throws IOException { | ||
| StringBuilder bulk = new StringBuilder(); | ||
|
|
||
| // Create index with source = enabled, doc_values = enabled, stored = false + multi-field | ||
| Request createAirlineDataRequest = new Request("PUT", "/airline-data"); | ||
| createAirlineDataRequest.setJsonEntity("{" | ||
| + " \"mappings\": {" | ||
| + " \"properties\": {" | ||
| + " \"time stamp\": { \"type\":\"date\"}," // space in 'time stamp' is intentional | ||
| + " \"airline\": {" | ||
| + " \"type\":\"keyword\"" | ||
| + " }," | ||
| + " \"responsetime\": { \"type\":\"float\"}" | ||
| + " }" | ||
| + " }" | ||
| + "}"); | ||
| client().performRequest(createAirlineDataRequest); | ||
|
|
||
| bulk.append("{\"index\": {\"_index\": \"airline-data\", \"_id\": 1}}\n"); | ||
| bulk.append("{\"time stamp\":\"2016-06-01T00:00:00Z\",\"airline\":\"AAA\",\"responsetime\":135.22}\n"); | ||
| bulk.append("{\"index\": {\"_index\": \"airline-data\", \"_id\": 2}}\n"); | ||
| bulk.append("{\"time stamp\":\"2016-06-01T01:59:00Z\",\"airline\":\"AAA\",\"responsetime\":541.76}\n"); | ||
|
|
||
| bulkIndex(bulk.toString()); | ||
| } | ||
|
|
||
| public void testExplain_GivenSecondaryHeadersAndConfig() throws IOException { | ||
| String config = "{\n" + | ||
| " \"source\": {\n" + | ||
| " \"index\": \"airline-data\"\n" + | ||
| " },\n" + | ||
| " \"analysis\": {\n" + | ||
| " \"regression\": {\n" + | ||
| " \"dependent_variable\": \"responsetime\"\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}"; | ||
|
|
||
|
|
||
| { // Request with secondary headers without perms | ||
| Request explain = explainRequestViaConfig(config); | ||
| RequestOptions.Builder options = explain.getOptions().toBuilder(); | ||
| addAuthHeader(options, SUPER_USER); | ||
| addSecondaryAuthHeader(options, ML_ADMIN); | ||
| explain.setOptions(options); | ||
| // Should throw | ||
| ResponseException ex = expectThrows(ResponseException.class, () -> client().performRequest(explain)); | ||
| assertThat(ex.getResponse().getStatusLine().getStatusCode(), equalTo(403)); | ||
| } | ||
| { // request with secondary headers with perms | ||
| Request explain = explainRequestViaConfig(config); | ||
| RequestOptions.Builder options = explain.getOptions().toBuilder(); | ||
| addAuthHeader(options, ML_ADMIN); | ||
| addSecondaryAuthHeader(options, SUPER_USER); | ||
| explain.setOptions(options); | ||
| // Should not throw | ||
| client().performRequest(explain); | ||
| } | ||
| } | ||
|
|
||
| public void testExplain_GivenSecondaryHeadersAndPreviouslyStoredConfig() throws IOException { | ||
| String config = "{\n" + | ||
| " \"source\": {\n" + | ||
| " \"index\": \"airline-data\"\n" + | ||
| " },\n" + | ||
| " \"dest\": {\n" + | ||
| " \"index\": \"response_prediction\"\n" + | ||
| " },\n" + | ||
| " \"analysis\":\n" + | ||
| " {\n" + | ||
| " \"regression\": {\n" + | ||
| " \"dependent_variable\": \"responsetime\"\n" + | ||
| " }\n" + | ||
| " }\n" + | ||
| "}"; | ||
|
|
||
| String configId = "explain_test"; | ||
|
|
||
| Request storeConfig = new Request("PUT", "_ml/data_frame/analytics/" + configId); | ||
| storeConfig.setJsonEntity(config); | ||
| client().performRequest(storeConfig); | ||
|
|
||
| { // Request with secondary headers without perms | ||
| Request explain = explainRequestConfigId(configId); | ||
| RequestOptions.Builder options = explain.getOptions().toBuilder(); | ||
| addAuthHeader(options, SUPER_USER); | ||
| addSecondaryAuthHeader(options, ML_ADMIN); | ||
| explain.setOptions(options); | ||
| // Should throw | ||
| ResponseException ex = expectThrows(ResponseException.class, () -> client().performRequest(explain)); | ||
| assertThat(ex.getResponse().getStatusLine().getStatusCode(), equalTo(403)); | ||
| } | ||
| { // request with secondary headers with perms | ||
| Request explain = explainRequestConfigId(configId); | ||
| RequestOptions.Builder options = explain.getOptions().toBuilder(); | ||
| addAuthHeader(options, ML_ADMIN); | ||
| addSecondaryAuthHeader(options, SUPER_USER); | ||
| explain.setOptions(options); | ||
| // Should not throw | ||
| client().performRequest(explain); | ||
| } | ||
| } | ||
|
|
||
| private static Request explainRequestViaConfig(String config) { | ||
| Request request = new Request("POST", "_ml/data_frame/analytics/_explain"); | ||
| request.setJsonEntity(config); | ||
| return request; | ||
| } | ||
|
|
||
| private static Request explainRequestConfigId(String id) { | ||
| return new Request("POST", "_ml/data_frame/analytics/" + id + "/_explain"); | ||
| } | ||
|
|
||
| private void bulkIndex(String bulk) throws IOException { | ||
| Request bulkRequest = new Request("POST", "/_bulk"); | ||
| bulkRequest.setJsonEntity(bulk); | ||
| bulkRequest.addParameter("refresh", "true"); | ||
| bulkRequest.addParameter("pretty", null); | ||
| String bulkResponse = EntityUtils.toString(client().performRequest(bulkRequest).getEntity()); | ||
| assertThat(bulkResponse, not(containsString("\"errors\": false"))); | ||
| } | ||
|
|
||
| } | ||
This file contains 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
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.
nit: new line after end of method