Skip to content
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

Preserve request headers in a mixed version cluster #79412

Merged
merged 4 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.elasticsearch.node.Node;
import org.elasticsearch.xpack.core.security.authc.Authentication;
import org.elasticsearch.xpack.core.security.authc.Authentication.AuthenticationType;
import org.elasticsearch.xpack.core.security.authc.AuthenticationField;
import org.elasticsearch.xpack.core.security.authc.support.AuthenticationContextSerializer;
import org.elasticsearch.xpack.core.security.authc.support.SecondaryAuthentication;
import org.elasticsearch.xpack.core.security.user.User;
Expand Down Expand Up @@ -157,12 +158,19 @@ public <T> T executeWithAuthentication(Authentication authentication, Function<S
* The original context is provided to the consumer. When this method returns, the original context is restored.
*/
public void executeAfterRewritingAuthentication(Consumer<StoredContext> consumer, Version version) {
// Preserve request headers other than authentication
final Map<String, String> existingRequestHeaders = threadContext.getRequestHeadersOnly();
final StoredContext original = threadContext.newStoredContext(true);
final Authentication authentication = getAuthentication();
try (ThreadContext.StoredContext ignore = threadContext.stashContext()) {
setAuthentication(new Authentication(authentication.getUser(), authentication.getAuthenticatedBy(),
authentication.getLookedUpBy(), version, authentication.getAuthenticationType(),
rewriteMetadataForApiKeyRoleDescriptors(version, authentication)));
existingRequestHeaders.forEach((k, v) -> {
if (false == AuthenticationField.AUTHENTICATION_KEY.equals(k)) {
threadContext.putHeader(k, v);
}
});
consumer.accept(original);
}
}
Comment on lines 160 to 176
Copy link
Member Author

@ywangd ywangd Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method does not preserve response headers because the original threadContext is wrapped in a restorable that does not propogate the response headers:

securityContext.executeAfterRewritingAuthentication(original -> sendWithUser(connection, action, request, options,
new ContextRestoreResponseHandler<>(threadPool.getThreadContext().wrapRestorable(original), handler), sender),
minVersion);

public Supplier<StoredContext> wrapRestorable(StoredContext storedContext) {
return () -> {
StoredContext context = newStoredContext(false);

But I believe the response headers are actually preserved without this rewriting, i.e. when nodes are on the same version:

Supplier<ThreadContext.StoredContext> storedContextSupplier = threadPool.getThreadContext().newRestorableContext(true);
ContextRestoreResponseHandler<T> responseHandler = new ContextRestoreResponseHandler<>(storedContextSupplier, handler);

I don't think it needs to be addressed in this PR since it's been there for a long while and no issue has been raised AFAIK. But maybe in a follow-up?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import static org.elasticsearch.xpack.core.security.authc.Authentication.VERSION_API_KEY_ROLES_AS_BYTES;
import static org.elasticsearch.xpack.core.security.authc.AuthenticationField.API_KEY_LIMITED_ROLE_DESCRIPTORS_KEY;
import static org.elasticsearch.xpack.core.security.authc.AuthenticationField.API_KEY_ROLE_DESCRIPTORS_KEY;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.instanceOf;

public class SecurityContextTests extends ESTestCase {
Expand Down Expand Up @@ -119,6 +120,11 @@ public void testExecuteAfterRewritingAuthentication() throws IOException {
RealmRef authBy = new RealmRef("ldap", "foo", "node1");
final Authentication original = new Authentication(user, authBy, authBy);
original.writeToContext(threadContext);
final Map<String, String> requestHeaders = Map.of(
AuthenticationField.PRIVILEGE_CATEGORY_KEY, randomAlphaOfLengthBetween(3, 10),
randomAlphaOfLengthBetween(3, 8), randomAlphaOfLengthBetween(3, 8)
);
threadContext.putHeader(requestHeaders);

final AtomicReference<StoredContext> contextAtomicReference = new AtomicReference<>();
securityContext.executeAfterRewritingAuthentication(originalCtx -> {
Expand All @@ -129,6 +135,8 @@ public void testExecuteAfterRewritingAuthentication() throws IOException {
assertEquals(VersionUtils.getPreviousVersion(), authentication.getVersion());
assertEquals(original.getAuthenticationType(), securityContext.getAuthentication().getAuthenticationType());
contextAtomicReference.set(originalCtx);
// Other request headers should be preserved
requestHeaders.forEach((k, v) -> assertThat(threadContext.getHeader(k), equalTo(v)));
}, VersionUtils.getPreviousVersion());

final Authentication authAfterExecution = securityContext.getAuthentication();
Expand Down
8 changes: 7 additions & 1 deletion x-pack/qa/rolling-upgrade/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ BuildParams.bwcVersions.withWireCompatiple { bwcVersion, baseName ->
if (bwcVersion.onOrAfter('6.6.0')) {
setting 'ccr.auto_follow.wait_for_metadata_timeout', '1s'
}
if (bwcVersion.onOrAfter('7.11.0')) {
extraConfigFile 'operator_users.yml', file("${project.projectDir}/src/test/resources/operator_users.yml")
setting 'xpack.security.operator_privileges.enabled', "true"
user username: "non_operator", password: 'x-pack-test-password', role: "superuser"
}

user username: "test_user", password: "x-pack-test-password"

Expand Down Expand Up @@ -131,7 +136,8 @@ BuildParams.bwcVersions.withWireCompatiple { bwcVersion, baseName ->
'mixed_cluster/90_ml_data_frame_analytics_crud/Put an outlier_detection job on the mixed cluster',
'mixed_cluster/110_enrich/Enrich stats query smoke test for mixed cluster',
'mixed_cluster/120_api_key/Test API key authentication will work in a mixed cluster',
'mixed_cluster/120_api_key/Create API key with metadata in a mixed cluster'
'mixed_cluster/120_api_key/Create API key with metadata in a mixed cluster',
'mixed_cluster/130_operator_privileges/Test operator privileges will work in the mixed cluster'
].join(',')
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
operator:
- usernames: ["test_user"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
"Test operator privileges will work in the mixed cluster":

- skip:
features: headers
version: " - 7.10.99"
reason: "operator privileges are available since 7.11"

# The default user ("test_user") is an operator, so this works
- do:
ywangd marked this conversation as resolved.
Show resolved Hide resolved
cluster.delete_voting_config_exclusions: { }

- do:
catch: forbidden
headers: # the non_operator user
Authorization: Basic bm9uX29wZXJhdG9yOngtcGFjay10ZXN0LXBhc3N3b3Jk
cluster.delete_voting_config_exclusions: { }