-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
Fix bugs for unexpired API keys and id filtering #76208
Merged
Merged
Changes from 1 commit
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
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
47 changes: 47 additions & 0 deletions
47
...ClusterTest/java/org/elasticsearch/xpack/security/authc/apikey/ApiKeySingleNodeTests.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,47 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License | ||
* 2.0; you may not use this file except in compliance with the Elastic License | ||
* 2.0. | ||
*/ | ||
|
||
package org.elasticsearch.xpack.security.authc.apikey; | ||
|
||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.core.TimeValue; | ||
import org.elasticsearch.index.query.QueryBuilders; | ||
import org.elasticsearch.test.SecuritySingleNodeTestCase; | ||
import org.elasticsearch.xpack.core.XPackSettings; | ||
import org.elasticsearch.xpack.core.security.action.CreateApiKeyAction; | ||
import org.elasticsearch.xpack.core.security.action.CreateApiKeyRequest; | ||
import org.elasticsearch.xpack.core.security.action.apikey.QueryApiKeyAction; | ||
import org.elasticsearch.xpack.core.security.action.apikey.QueryApiKeyRequest; | ||
import org.elasticsearch.xpack.core.security.action.apikey.QueryApiKeyResponse; | ||
|
||
import static org.hamcrest.Matchers.equalTo; | ||
|
||
public class ApiKeySingleNodeTests extends SecuritySingleNodeTestCase { | ||
|
||
@Override | ||
protected Settings nodeSettings() { | ||
Settings.Builder builder = Settings.builder().put(super.nodeSettings()); | ||
builder.put(XPackSettings.API_KEY_SERVICE_ENABLED_SETTING.getKey(), true); | ||
return builder.build(); | ||
} | ||
|
||
public void testQueryWithExpiredKeys() { | ||
final String id1 = client().execute(CreateApiKeyAction.INSTANCE, | ||
new CreateApiKeyRequest("expired-shortly", null, TimeValue.timeValueMillis(1), null)) | ||
.actionGet() | ||
.getId(); | ||
final String id2 = client().execute(CreateApiKeyAction.INSTANCE, | ||
new CreateApiKeyRequest("long-lived", null, TimeValue.timeValueDays(1), null)) | ||
.actionGet() | ||
.getId(); | ||
|
||
final QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest(QueryBuilders.idsQuery().addIds(id1, id2)); | ||
final QueryApiKeyResponse queryApiKeyResponse = client().execute(QueryApiKeyAction.INSTANCE, queryApiKeyRequest).actionGet(); | ||
assertThat(queryApiKeyResponse.getApiKeyInfos().length, equalTo(1)); | ||
assertThat(queryApiKeyResponse.getApiKeyInfos()[0].getId(), equalTo(id2)); | ||
} | ||
} |
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 |
---|---|---|
|
@@ -901,7 +901,7 @@ private void findApiKeys(final BoolQueryBuilder boolQuery, boolean filterOutInva | |
} | ||
if (filterOutExpiredKeys) { | ||
final BoolQueryBuilder expiredQuery = QueryBuilders.boolQuery(); | ||
expiredQuery.should(QueryBuilders.rangeQuery("expiration_time").lte(Instant.now().toEpochMilli())); | ||
expiredQuery.should(QueryBuilders.rangeQuery("expiration_time").gt(Instant.now().toEpochMilli())); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the old bug. But this piece of code was never exercised till now. |
||
expiredQuery.should(QueryBuilders.boolQuery().mustNot(QueryBuilders.existsQuery("expiration_time"))); | ||
boolQuery.filter(expiredQuery); | ||
} | ||
|
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 |
---|---|---|
|
@@ -33,7 +33,7 @@ public class ApiKeyBoolQueryBuilder extends BoolQueryBuilder { | |
|
||
// Field names allowed at the index level | ||
private static final Set<String> ALLOWED_EXACT_INDEX_FIELD_NAMES = | ||
Set.of("doc_type", "name", "api_key_invalidated", "creation_time", "expiration_time"); | ||
Set.of("_id", "doc_type", "name", "api_key_invalidated", "creation_time", "expiration_time"); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the new bug. |
||
|
||
private ApiKeyBoolQueryBuilder() {} | ||
|
||
|
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.
Should we ensure the clock has ticked here?
It should but eventually someone will run this on a machine that is so fast that the key hasn't expired by the time we search.
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.
Since the 1st key expires in just 1ms, the machine needs to be super fast and lucky to finish creating the 2nd key (hashing and wait_for) within that time frame. That said, it does not hurt to add a sleep for 10ms so I did it.