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

[#5851] Add error messages on authentication failures with username and password #6212

Merged
merged 10 commits into from
Dec 4, 2023
Merged

[#5851] Add error messages on authentication failures with username and password #6212

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
501e5f3
Add error messages on authentication failures with username and password
dlutzardo Nov 28, 2023
66f209e
Merge branch 'main' into issue_5851
dlutzardo Nov 29, 2023
242f219
Add a constant for the 'password'
dlutzardo Dec 4, 2023
c9ffc96
Add test to check empty login and check response in body is not empty
dlutzardo Dec 4, 2023
b7a8d17
Correct format (spotless)
dlutzardo Dec 4, 2023
0f97933
Update ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/j…
dlutzardo Dec 4, 2023
4a882d3
Update ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/j…
dlutzardo Dec 4, 2023
24106ed
Update JsonRpcHttpServiceLoginTest.java
dlutzardo Dec 4, 2023
408d718
Merge branch 'main' into issue_5851
fab-10 Dec 4, 2023
c366068
Add a CHANGELOG entry for PR 6212
dlutzardo Dec 4, 2023
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
11 changes: 7 additions & 4 deletions ...rg/hyperledger/besu/ethereum/api/jsonrpc/authentication/DefaultAuthenticationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
public class DefaultAuthenticationService implements AuthenticationService {

public static final String USERNAME = "username";
public static final String PASSWORD = "password";
private final JWTAuth jwtAuthProvider;
@VisibleForTesting public final JWTAuthOptions jwtAuthOptions;
private final Optional<AuthenticationProvider> credentialAuthProvider;
Expand Down Expand Up @@ -171,19 +172,21 @@ private void login(
final RoutingContext routingContext, final AuthenticationProvider credentialAuthProvider) {
final JsonObject requestBody = routingContext.body().asJsonObject();

if (requestBody == null) {
if (requestBody == null
|| requestBody.getValue(USERNAME) == null
|| requestBody.getValue(PASSWORD) == null) {
routingContext
.response()
.setStatusCode(HttpResponseStatus.BAD_REQUEST.code())
.setStatusMessage(HttpResponseStatus.BAD_REQUEST.reasonPhrase())
.end();
.end("Authentication failed: username and password are required.");
return;
}

// Check user
final JsonObject authParams = new JsonObject();
authParams.put(USERNAME, requestBody.getValue(USERNAME));
authParams.put("password", requestBody.getValue("password"));
authParams.put(PASSWORD, requestBody.getValue(PASSWORD));
final Credentials credentials = new UsernamePasswordCredentials(authParams);

credentialAuthProvider.authenticate(
Expand All @@ -194,7 +197,7 @@ private void login(
.response()
.setStatusCode(HttpResponseStatus.UNAUTHORIZED.code())
.setStatusMessage(HttpResponseStatus.UNAUTHORIZED.reasonPhrase())
.end();
.end("Authentication failed: the username or password is incorrect.");
} else {
final User user = r.result();

Expand Down
14 changes: 14 additions & 0 deletions .../src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/JsonRpcHttpServiceLoginTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,18 @@ public static void shutdownServer() {
service.stop().join();
}

@Test
public void loginWithEmptyCredentials() throws IOException {
final RequestBody body = RequestBody.create("{}", JSON);
final Request request = new Request.Builder().post(body).url(baseUrl + "/login").build();
try (final Response resp = client.newCall(request).execute()) {
assertThat(resp.code()).isEqualTo(400);
assertThat(resp.message()).isEqualTo("Bad Request");
final String bodyString = resp.body().string();
assertThat(bodyString).contains("username and password are required");
}
}

@Test
public void loginWithBadCredentials() throws IOException {
final RequestBody body =
Expand All @@ -211,6 +223,8 @@ public void loginWithBadCredentials() throws IOException {
try (final Response resp = client.newCall(request).execute()) {
assertThat(resp.code()).isEqualTo(401);
assertThat(resp.message()).isEqualTo("Unauthorized");
final String bodyString = resp.body().string();
assertThat(bodyString).contains("the username or password is incorrect");
}
}

Expand Down
Loading