Ensure CreateApiKey always creates a new document (elastic#88413)

The OpType of the indexRequest used for creating new API keys does not have its OpType configured. This means it defaults to OpType.INDEX which allows it to replace an existing document. This PR fixes it by explicity set OpType to CREATE so that it always create a new document (or throw error if ID conflict does happen). Since API key ID is time-based random base64 UUID, it is unlikely for this to happen in practice and we are not aware of any related bug report.
ywangd · Jul 11, 2022 · 477ab8d · 477ab8d
1 parent 927ee8f
commit 477ab8d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/docs/changelog/88413.yaml b/docs/changelog/88413.yaml
@@ -0,0 +1,5 @@
+pr: 88413
+summary: Ensure `CreateApiKey` always creates a new document
+area: Security
+type: bug
+issues: []
diff --git a/...k/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/ApiKeyService.java b/...k/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/ApiKeyService.java
@@ -304,6 +304,7 @@ private void createApiKeyAndIndexIt(
                 final IndexRequest indexRequest = client.prepareIndex(SECURITY_MAIN_ALIAS)
                     .setSource(builder)
                     .setId(request.getId())
+                    .setOpType(DocWriteRequest.OpType.CREATE)
                     .setRefreshPolicy(request.getRefreshPolicy())
                     .request();
                 final BulkRequest bulkRequest = toSingleItemBulkRequest(indexRequest);
@@ -317,6 +318,7 @@ private void createApiKeyAndIndexIt(
                         bulkRequest,
                         TransportSingleItemBulkWriteAction.<IndexResponse>wrapBulkResponse(ActionListener.wrap(indexResponse -> {
                             assert request.getId().equals(indexResponse.getId());
+                            assert indexResponse.getResult() == DocWriteResponse.Result.CREATED;
                             final ListenableFuture<CachedApiKeyHashResult> listenableFuture = new ListenableFuture<>();
                             listenableFuture.onResponse(new CachedApiKeyHashResult(true, apiKey));
                             apiKeyAuthCache.put(request.getId(), listenableFuture);

diff --git a/...gin/security/src/test/java/org/elasticsearch/xpack/security/authc/ApiKeyServiceTests.java b/...gin/security/src/test/java/org/elasticsearch/xpack/security/authc/ApiKeyServiceTests.java
@@ -206,6 +206,8 @@ public void testCreateApiKeyUsesBulkIndexAction() throws Exception {
             assertThat(bulkRequest.requests().get(0), instanceOf(IndexRequest.class));
             IndexRequest indexRequest = (IndexRequest) bulkRequest.requests().get(0);
             assertThat(indexRequest.id(), is(createApiKeyRequest.getId()));
+            // The index request has opType create so that it will *not* override any existing document
+            assertThat(indexRequest.opType(), is(DocWriteRequest.OpType.CREATE));
             bulkActionInvoked.set(true);
             return null;
         }).when(client).execute(eq(BulkAction.INSTANCE), any(BulkRequest.class), any());