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.

Sign up for GitHub

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

Jump to bottom

API key name should always be required for creation #59836

Merged
merged 2 commits into from
Aug 4, 2020
Merged

API key name should always be required for creation #59836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03037f0
API key name is now required in all cases
ywangd Jul 20, 2020
ee1ed15
fix tests
ywangd Jul 20, 2020
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
2 changes: 1 addition & 1 deletion .../rest-high-level/src/main/java/org/elasticsearch/client/security/CreateApiKeyRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public final class CreateApiKeyRequest implements Validatable, ToXContentObject
* @param roles list of {@link Role}s
* @param expiration to specify expiration for the API key
*/
public CreateApiKeyRequest(@Nullable String name, List<Role> roles, @Nullable TimeValue expiration,
public CreateApiKeyRequest(String name, List<Role> roles, @Nullable TimeValue expiration,
@Nullable final RefreshPolicy refreshPolicy) {
this.name = name;
this.roles = Objects.requireNonNull(roles, "roles may not be null");
Expand Down
15 changes: 9 additions & 6 deletions .../core/src/main/java/org/elasticsearch/xpack/core/security/action/CreateApiKeyRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.action.support.WriteRequest;
import org.elasticsearch.common.Nullable;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.unit.TimeValue;
Expand Down Expand Up @@ -43,7 +44,7 @@ public CreateApiKeyRequest() {}
* @param roleDescriptors list of {@link RoleDescriptor}s
* @param expiration to specify expiration for the API key
*/
public CreateApiKeyRequest(@Nullable String name, @Nullable List<RoleDescriptor> roleDescriptors, @Nullable TimeValue expiration) {
public CreateApiKeyRequest(String name, @Nullable List<RoleDescriptor> roleDescriptors, @Nullable TimeValue expiration) {
this.name = name;
this.roleDescriptors = (roleDescriptors == null) ? List.of() : List.copyOf(roleDescriptors);
this.expiration = expiration;
Expand All @@ -65,7 +66,7 @@ public String getName() {
return name;
}

public void setName(@Nullable String name) {
public void setName(String name) {
this.name = name;
}

Expand Down Expand Up @@ -96,15 +97,17 @@ public void setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy) {
@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException validationException = null;
if (name != null) {
if (Strings.isNullOrEmpty(name)) {
validationException = addValidationError("api key name is required", validationException);
} else {
if (name.length() > 256) {
validationException = addValidationError("name may not be more than 256 characters long", validationException);
validationException = addValidationError("api key name may not be more than 256 characters long", validationException);
}
if (name.equals(name.trim()) == false) {
validationException = addValidationError("name may not begin or end with whitespace", validationException);
validationException = addValidationError("api key name may not begin or end with whitespace", validationException);
}
if (name.startsWith("_")) {
validationException = addValidationError("name may not begin with an underscore", validationException);
validationException = addValidationError("api key name may not begin with an underscore", validationException);
}
}
return validationException;
Expand Down
13 changes: 7 additions & 6 deletions .../src/test/java/org/elasticsearch/xpack/core/security/action/CreateApiKeyRequestTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ public void testNameValidation() {
CreateApiKeyRequest request = new CreateApiKeyRequest();

ActionRequestValidationException ve = request.validate();
assertNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("api key name is required"));

request.setName(name);
ve = request.validate();
Expand All @@ -38,25 +39,25 @@ public void testNameValidation() {
ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("name may not be more than 256 characters long"));
assertThat(ve.validationErrors().get(0), containsString("api key name may not be more than 256 characters long"));

request.setName(" leading space");
ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("name may not begin or end with whitespace"));
assertThat(ve.validationErrors().get(0), containsString("api key name may not begin or end with whitespace"));

request.setName("trailing space ");
ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("name may not begin or end with whitespace"));
assertThat(ve.validationErrors().get(0), containsString("api key name may not begin or end with whitespace"));

request.setName(" leading and trailing space ");
ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("name may not begin or end with whitespace"));
assertThat(ve.validationErrors().get(0), containsString("api key name may not begin or end with whitespace"));

request.setName("inner space");
ve = request.validate();
Expand All @@ -66,7 +67,7 @@ public void testNameValidation() {
ve = request.validate();
assertNotNull(ve);
assertThat(ve.validationErrors().size(), is(1));
assertThat(ve.validationErrors().get(0), containsString("name may not begin with an underscore"));
assertThat(ve.validationErrors().get(0), containsString("api key name may not begin with an underscore"));
}

public void testSerialization() throws IOException {
Expand Down
20 changes: 20 additions & 0 deletions ...qa/security-trial/src/test/java/org/elasticsearch/xpack/security/apikey/ApiKeyRestIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import org.elasticsearch.client.Request;
import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.Response;
import org.elasticsearch.client.ResponseException;
import org.elasticsearch.client.security.support.ApiKey;
import org.elasticsearch.common.collect.Tuple;
import org.elasticsearch.common.settings.SecureString;
Expand All @@ -26,6 +27,7 @@
import java.util.Map;
import java.util.Set;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.hamcrest.Matchers.instanceOf;
Expand Down Expand Up @@ -115,4 +117,22 @@ public void testGrantApiKeyForOtherUserWithAccessToken() throws IOException {
assertThat(apiKey.getExpiration(), greaterThanOrEqualTo(minExpiry));
assertThat(apiKey.getExpiration(), lessThanOrEqualTo(maxExpiry));
}

public void testGrantApiKeyWithoutApiKeyNameWillFail() throws IOException {
Request request = new Request("POST", "_security/api_key/grant");
request.setOptions(RequestOptions.DEFAULT.toBuilder().addHeader("Authorization",
UsernamePasswordToken.basicAuthHeaderValue(SYSTEM_USER, SYSTEM_USER_PASSWORD)));
final Map<String, Object> requestBody = Map.ofEntries(
Map.entry("grant_type", "password"),
Map.entry("username", END_USER),
Map.entry("password", END_USER_PASSWORD.toString())
);
request.setJsonEntity(XContentTestUtils.convertToXContent(requestBody, XContentType.JSON).utf8ToString());

final ResponseException e =
expectThrows(ResponseException.class, () -> client().performRequest(request));

assertEquals(400, e.getResponse().getStatusLine().getStatusCode());
assertThat(e.getMessage(), containsString("api key name is required"));
}
}
10 changes: 10 additions & 0 deletions ...lugin/security/src/test/java/org/elasticsearch/xpack/security/authc/ApiKeyIntegTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package org.elasticsearch.xpack.security.authc;

import org.elasticsearch.ElasticsearchSecurityException;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.action.DocWriteResponse;
import org.elasticsearch.action.admin.cluster.node.info.NodeInfo;
import org.elasticsearch.action.admin.indices.refresh.RefreshAction;
Expand Down Expand Up @@ -221,6 +222,15 @@ public void testMultipleApiKeysCanHaveSameName() {
}
}

public void testCreateApiKeyWithoutNameWillFail() {
Client client = client().filterWithHeader(Collections.singletonMap("Authorization",
UsernamePasswordToken.basicAuthHeaderValue(SecuritySettingsSource.TEST_SUPERUSER,
SecuritySettingsSourceField.TEST_PASSWORD_SECURE_STRING)));
final ActionRequestValidationException e =
expectThrows(ActionRequestValidationException.class, () -> new CreateApiKeyRequestBuilder(client).get());
assertThat(e.getMessage(), containsString("api key name is required"));
}

public void testInvalidateApiKeysForRealm() throws InterruptedException, ExecutionException {
int noOfApiKeys = randomIntBetween(3, 5);
List<CreateApiKeyResponse> responses = createApiKeys(noOfApiKeys, null);
Expand Down