Skip to content

Replace AuthConfig toString implementation #1506

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

Merged
bsideup merged 2 commits into from
Nov 26, 2020
Merged

Replace AuthConfig toString implementation #1506

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
80709b6
Obfuscate sensitive values in AuthConfig toString
rnorth Nov 25, 2020
5a717db
Update AuthConfig.java
bsideup Nov 26, 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
6 changes: 5 additions & 1 deletion docker-java-api/src/main/java/com/github/dockerjava/api/model/AuthConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import java.io.Serializable;

@EqualsAndHashCode
@ToString
@ToString(onlyExplicitlyIncluded = true)
public class AuthConfig implements Serializable {
private static final long serialVersionUID = 1L;

Expand All @@ -20,15 +20,18 @@ public class AuthConfig implements Serializable {
public static final String DEFAULT_SERVER_ADDRESS = "https://index.docker.io/v1/";

@JsonProperty("username")
@ToString.Include
private String username;

@JsonProperty("password")
private String password;

@JsonProperty("email")
@ToString.Include
private String email;

@JsonProperty("serveraddress")
@ToString.Include
private String registryAddress = DEFAULT_SERVER_ADDRESS;

@JsonProperty("auth")
Expand All @@ -50,6 +53,7 @@ public class AuthConfig implements Serializable {
* @since {@link com.github.dockerjava.core.RemoteApiVersion#VERSION_1_25}
*/
@JsonProperty("stackOrchestrator")
@ToString.Include
private String stackOrchestrator;

public String getUsername() {
Expand Down
24 changes: 21 additions & 3 deletions docker-java/src/test/java/com/github/dockerjava/api/model/AuthConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
import java.io.IOException;

import static com.github.dockerjava.test.serdes.JSONSamples.testRoundTrip;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.CoreMatchers.*;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.notNullValue;
import static org.junit.Assert.assertEquals;

Expand Down Expand Up @@ -89,4 +88,23 @@ public void shouldNotFailWithStackOrchestratorInConfig() throws IOException {
assertThat(authConfig.getStackOrchestrator(), is("kubernetes"));
}

@Test
public void toStringDoesNotContainSensitiveStrings() {
AuthConfig authConfig = new AuthConfig()
.withAuth("authValue")
.withEmail("emailValue")
.withPassword("passwordValue")
.withIdentityToken("identityTokenValue")
.withRegistrytoken("registryTokenValue")
.withRegistryAddress("registryAddressValue");
String toStringValue = authConfig.toString();

assertThat(toStringValue, not(containsString("authValue")));
assertThat(toStringValue, not(containsString("passwordValue")));
assertThat(toStringValue, not(containsString("identityTokenValue")));
assertThat(toStringValue, not(containsString("registryTokenValue")));

assertThat(toStringValue, containsString("emailValue"));
assertThat(toStringValue, containsString("registryAddressValue"));
}
}