Skip to content

Commit

Permalink
DATAREDIS-1060 - Polishing.
Browse files Browse the repository at this point in the history 
Remove data node password reuse for sentinel as we favor explicit configuration over implicit.
Use RedisURI builder and not sentinel URI builder to configure the SentinelURI correctly.
Associate masterId with outermost RedisURI.

Original pull request: #495.
  • Loading branch information
@mp911de
mp911de committed Nov 12, 2019
1 parent 1955074 commit c6802ba
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 129 deletions.
43 changes: 10 additions & 33 deletions src/main/java/org/springframework/data/redis/connection/RedisConfiguration.java
View file
Expand Up @@ -339,77 +339,54 @@ default void setMaster(final String name) {
Set<RedisNode> getSentinels();

/**
* Get the {@link RedisPassword} used when authenticating with a Redis Server.
*
* Get the {@link RedisPassword} used when authenticating with a Redis Server..
*
* @return never {@literal null}.
* @since 2.2.2
*/
default RedisPassword getDataNodePassword() {
return getPassword();
}

/**
* Create and set a {@link RedisPassword} to be used when authenticating with Sentinel from the given {@link String}
* Create and set a {@link RedisPassword} to be used when authenticating with Redis Sentinel from the given
* {@link String}.
*
* @param password can be {@literal null}.
* @throws IllegalStateException if the {@link #useDataNodeAuthenticationForSentinel(boolean) Data Node Password}
* should be used for authenticating with Redis Sentinel.
* @since 2.2.2
*/
default void setSentinelPassword(@Nullable String password) {
setSentinelPassword(RedisPassword.of(password));
}

/**
* Create and set a {@link RedisPassword} to be used when authenticating with Sentinel from the given
* Create and set a {@link RedisPassword} to be used when authenticating with Redis Sentinel from the given
* {@link Character} sequence.
*
* @param password can be {@literal null}.
* @throws IllegalStateException if the {@link #useDataNodeAuthenticationForSentinel(boolean) Data Node Password}
* should be used for authenticating with Redis Sentinel.
* @since 2.2.2
*/
default void setSentinelPassword(@Nullable char[] password) {
setSentinelPassword(RedisPassword.of(password));
}

/**
* Set a {@link RedisPassword} to be used when authenticating with Sentinel.
* Set a {@link RedisPassword} to be used when authenticating with Redis Sentinel.
*
* @param password must not be {@literal null} use {@link RedisPassword#none()} instead.
* @throws IllegalStateException if the {@link #useDataNodeAuthenticationForSentinel(boolean) Data Node Password}
* should be used for authenticating with Redis Sentinel.
* @since 2.2.2
*/
void setSentinelPassword(RedisPassword password);

/**
* Get the {@link RedisPassword} to use when connecting to a Redis Sentinel. <br />
* This can be the password explicitly set via {@link #setSentinelPassword(RedisPassword)}, or the
* {@link #getDataNodePassword() Data Node password} if it should be also used for
* {@link #getUseDataNodeAuthenticationForSentinel() sentinel}, or {@link RedisPassword#none()} if no password has
* Returns the {@link RedisPassword} to use when connecting to a Redis Sentinel. <br />
* Can be set via {@link #setSentinelPassword(RedisPassword)} or {@link RedisPassword#none()} if no password has
* been set.
*
* @return the {@link RedisPassword} for authenticating with Sentinel.
* @return the {@link RedisPassword} for authenticating with Redis Sentinel.
* @since 2.2.2
*/
RedisPassword getSentinelPassword();

/**
* Use the {@link #getDataNodePassword() RedisPassword} also for authentication with Redis Sentinel.
*
* @param useDataNodeAuthenticationForSentinel
* @throws IllegalStateException if a {@link #getSentinelPassword() Sentinel Password} is already set.
* @since 2.2.2
*/
void useDataNodeAuthenticationForSentinel(boolean useDataNodeAuthenticationForSentinel);

/**
* Use the {@link #getDataNodePassword() RedisPassword} also for authentication with Redis Sentinel.
*
* @return
* @since 2.2.2
*/
boolean getUseDataNodeAuthenticationForSentinel();
}

/**
Expand Down
33 changes: 3 additions & 30 deletions src/main/java/org/springframework/data/redis/connection/RedisSentinelConfiguration.java
View file
Expand Up @@ -52,7 +52,6 @@ public class RedisSentinelConfiguration implements RedisConfiguration, SentinelC

private RedisPassword dataNodePassword = RedisPassword.none();
private RedisPassword sentinelPassword = RedisPassword.none();
private boolean useDataNodePasswordForSentinel = false;

/**
* Creates new {@link RedisSentinelConfiguration}.
Expand Down Expand Up @@ -253,47 +252,21 @@ public void setPassword(RedisPassword password) {

/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#setSentinelPassword(org.springframework.data.redis.connection.RedisPassword)
* @see org.springframework.data.redis.connection.RedisConfiguration.SentinelConfiguration#setSentinelPassword(org.springframework.data.redis.connection.RedisPassword)
*/
public void setSentinelPassword(RedisPassword sentinelPassword) {

Assert.state(!useDataNodePasswordForSentinel,
"Configuration uses Redis Data Node password for authenticating with Sentinel. Please set 'RedisSentinelConfiguration.useDataNodeAuthenticationForSentinel(false)' before using this option.");
Assert.notNull(sentinelPassword, "SentinelPassword must not be null!");
this.sentinelPassword = sentinelPassword;
}

/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#setSentinelPassword()
* @see org.springframework.data.redis.connection.RedisConfiguration.SentinelConfiguration#setSentinelPassword()
*/
@Override
public RedisPassword getSentinelPassword() {
return getUseDataNodeAuthenticationForSentinel() ? this.dataNodePassword : sentinelPassword;
}

/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#useDataNodeAuthenticationForSentinel(boolean)
*/
@Override
public void useDataNodeAuthenticationForSentinel(boolean useDataNodeAuthenticationForSentinel) {

if (useDataNodeAuthenticationForSentinel) {
Assert.state(!this.sentinelPassword.isPresent(),
"Configuration already defines a password for authenticating with Sentinel. Please use 'RedisSentinelConfiguration.setSentinelPassword(RedisPassword.none())' remove the password.");
}

this.useDataNodePasswordForSentinel = useDataNodeAuthenticationForSentinel;
}

/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.RedisConfiguration.WithPassword#getUseDataNodeAuthenticationForSentinel()
*/
@Override
public boolean getUseDataNodeAuthenticationForSentinel() {
return this.useDataNodePasswordForSentinel;
return sentinelPassword;
}

private RedisNode readHostAndPortFromString(String hostAndPort) {
Expand Down
12 changes: 7 additions & 5 deletions src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConverters.java
View file
Expand Up @@ -640,23 +640,25 @@ public static RedisURI sentinelConfigurationToRedisURI(RedisSentinelConfiguratio
Assert.notNull(sentinelConfiguration, "RedisSentinelConfiguration is required");

Set<RedisNode> sentinels = sentinelConfiguration.getSentinels();
RedisPassword sentinelPassword = sentinelConfiguration.getSentinelPassword();
RedisURI.Builder builder = RedisURI.builder();
for (RedisNode sentinel : sentinels) {

RedisURI.Builder uri = RedisURI.Builder.sentinel(sentinel.getHost(), sentinel.getPort(),
sentinelConfiguration.getMaster().getName());
RedisURI.Builder sentinelBuilder = RedisURI.Builder.redis(sentinel.getHost(), sentinel.getPort());

if (sentinelConfiguration.getSentinelPassword().isPresent()) {
uri.withPassword(sentinelConfiguration.getSentinelPassword().get());
if (sentinelPassword.isPresent()) {
sentinelBuilder.withPassword(sentinelPassword.get());
}
builder.withSentinel(uri.build());
builder.withSentinel(sentinelBuilder.build());
}

RedisPassword password = sentinelConfiguration.getPassword();
if (password.isPresent()) {
builder.withPassword(password.get());
}

builder.withSentinelMasterId(sentinelConfiguration.getMaster().getName());

return builder.build();
}

Expand Down
38 changes: 1 addition & 37 deletions ...t/java/org/springframework/data/redis/connection/RedisSentinelConfigurationUnitTests.java
View file
Expand Up @@ -120,41 +120,6 @@ public void shouldBeCreatedCorrecltyGivenValidPropertySourceWithMasterAndMultipl
new RedisNode("localhost", 789));
}

@Test // DATAREDIS-1060
public void throwsExceptionOnSentinelPasswordAlreadySetWhenTryingToReuseDataNodePassword() {

RedisSentinelConfiguration configuration = new RedisSentinelConfiguration("myMaster",
Collections.singleton(HOST_AND_PORT_1));
configuration.setSentinelPassword(RedisPassword.of("so-secret-you'll-never-guess-123"));

assertThatExceptionOfType(IllegalStateException.class)
.isThrownBy(() -> configuration.useDataNodeAuthenticationForSentinel(true));
}

@Test // DATAREDIS-1060
public void throwsExceptionOnSettingSentinelPasswordWhenAlreadyReusingDataNodePassword() {

RedisSentinelConfiguration configuration = new RedisSentinelConfiguration("myMaster",
Collections.singleton(HOST_AND_PORT_1));
configuration.setPassword(RedisPassword.of("qwerty"));
configuration.useDataNodeAuthenticationForSentinel(true);

assertThatExceptionOfType(IllegalStateException.class)
.isThrownBy(() -> configuration.setSentinelPassword(RedisPassword.of("who-needs-security-anyway")));
}

@Test // DATAREDIS-1060
public void settingSentinelPasswordReturnsDataNodePasswordIfUseDataNodeAuthIsTrue() {

RedisPassword password = RedisPassword.of("monkey-dragon->yeah-getting-better-combining-trivial-ones");
RedisSentinelConfiguration configuration = new RedisSentinelConfiguration("myMaster",
Collections.singleton(HOST_AND_PORT_1));
configuration.setPassword(password);
configuration.useDataNodeAuthenticationForSentinel(true);

assertThat(configuration.getSentinelPassword()).isEqualTo(password);
}

@Test // DATAREDIS-1060
public void dataNodePasswordDoesNotAffectSentinelPassword() {

Expand All @@ -177,7 +142,6 @@ public void readSentinelPasswordFromConfigProperty() {
RedisSentinelConfiguration config = new RedisSentinelConfiguration(propertySource);

assertThat(config.getSentinelPassword()).isEqualTo(RedisPassword.of("computer-says-no"));
assertThat(config.getSentinels().size()).isEqualTo(1);
assertThat(config.getSentinels()).contains(new RedisNode("127.0.0.1", 123));
assertThat(config.getSentinels()).hasSize(1).contains(new RedisNode("127.0.0.1", 123));
}
}
24 changes: 0 additions & 24 deletions .../org/springframework/data/redis/connection/lettuce/LettuceConnectionFactoryUnitTests.java
View file
Expand Up @@ -224,30 +224,6 @@ public void sentinelPasswordShouldBeSetOnSentinelClient() {
}
}

@Test // DATAREDIS-1060
public void redisPasswordShouldBeSetOnSentinelClientIfItShouldBeReused() {

RedisSentinelConfiguration config = new RedisSentinelConfiguration("mymaster", Collections.singleton("host:1234"));
config.useDataNodeAuthenticationForSentinel(true);

LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(config);
connectionFactory.setClientResources(getSharedClientResources());
connectionFactory.setPassword("o_O");
connectionFactory.afterPropertiesSet();
ConnectionFactoryTracker.add(connectionFactory);

AbstractRedisClient client = (AbstractRedisClient) getField(connectionFactory, "client");
assertThat(client).isInstanceOf(RedisClient.class);

RedisURI redisUri = (RedisURI) getField(client, "redisURI");

assertThat(redisUri.getPassword()).isEqualTo(connectionFactory.getPassword().toCharArray());

for (RedisURI sentinel : redisUri.getSentinels()) {
assertThat(sentinel.getPassword()).isEqualTo("o_O".toCharArray());
}
}

@Test // DATAREDIS-1060
public void sentinelPasswordShouldNotLeakIntoDataNodeClient() {

Expand Down

0 comments on commit c6802ba

Please sign in to comment.