Skip to content
This repository has been archived by the owner on Jul 6, 2023. It is now read-only.

Commit

Permalink
Merge pull request #202 from pontusmelke/4.0-allow-password-change
Browse files Browse the repository at this point in the history 
Allow user to update expired password non-interactively
  • Loading branch information
@pontusmelke
pontusmelke authored Feb 7, 2020
2 parents 25f095a + 9b3c2af commit 5494d30
Show file tree
Hide file tree
Showing 15 changed files with 319 additions and 307 deletions.
161 changes: 119 additions & 42 deletions cypher-shell/src/integration-test/java/org/neo4j/shell/MainIntegrationTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import org.neo4j.driver.exceptions.ServiceUnavailableException;
import org.neo4j.driver.exceptions.TransientException;
import org.neo4j.shell.cli.CliArgs;
import org.neo4j.shell.cli.Format;
import org.neo4j.shell.commands.CommandHelper;
import org.neo4j.shell.exception.CommandException;
import org.neo4j.shell.exception.ExitException;
Expand All @@ -37,10 +38,16 @@
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.neo4j.shell.DatabaseManager.DEFAULT_DEFAULT_DB_NAME;
import static org.neo4j.shell.DatabaseManager.SYSTEM_DB_NAME;
import static org.neo4j.shell.Main.EXIT_FAILURE;
import static org.neo4j.shell.Main.EXIT_SUCCESS;
import static org.neo4j.shell.util.Versions.majorVersion;

public class MainIntegrationTest
{
private static String USER = "neo4j";
private static String PASSWORD = "neo";

private static class ShellAndConnection
{
Expand All @@ -56,7 +63,7 @@ private static class ShellAndConnection

@Rule
public final ExpectedException exception = ExpectedException.none();
private String inputString = String.format( "neo4j%nneo%n" );
private String inputString = String.format( "%s%n%s%n", USER, PASSWORD );
private ByteArrayOutputStream baos;
private ConnectionConfig connectionConfig;
private CliArgs cliArgs;
Expand Down Expand Up @@ -89,7 +96,7 @@ public void setup() {

private void ensureUser() throws Exception {
if (majorVersion(shell.getServerVersion() ) >= 4) {
shell.execute(":use " + DatabaseManager.SYSTEM_DB_NAME);
shell.execute(":use " + SYSTEM_DB_NAME);
shell.execute("CREATE OR REPLACE USER foo SET PASSWORD 'pass';");
shell.execute("GRANT ROLE reader TO foo;");
shell.execute(":use");
Expand Down Expand Up @@ -134,41 +141,23 @@ public void promptsOnWrongAuthenticationIfInteractive() throws Exception {

@Test
public void promptsOnPasswordChangeRequired() throws Exception {
shell.setCommandHelper(new CommandHelper(mock(Logger.class), Historian.empty, shell));
inputBuffer.put(String.format("foo%npass%nnewpass%n").getBytes());

assertEquals("", connectionConfig.username());
assertEquals("", connectionConfig.password());

// when
main.connectMaybeInteractively(shell, connectionConfig, true, true);

// then
// should be connected
assertTrue(shell.isConnected());
// should have prompted and set the username and password
String expectedLoginOutput = format( "username: neo4j%npassword: ***%n" );
assertEquals(expectedLoginOutput, baos.toString());
assertEquals("neo4j", connectionConfig.username());
assertEquals("neo", connectionConfig.password());

// Create a new user
ensureUser();
shell.disconnect();
int majorVersion = getVersionAndCreateUserWithPasswordChangeRequired();

connectionConfig = getConnectionConfig(cliArgs);
assertEquals("", connectionConfig.username());
assertEquals("", connectionConfig.password());

// when
inputBuffer.put(String.format("foo%npass%nnewpass%n").getBytes());
baos.reset();
main.connectMaybeInteractively(shell, connectionConfig, true, true);

// then
assertTrue(shell.isConnected());
if (majorVersion(shell.getServerVersion() ) >= 4) {
if (majorVersion >= 4) {
// should have prompted to change the password
String expectedChangePasswordOutput = format( "username: foo%npassword: ****%nPassword change required%nnew password: *******%n" );
assertEquals(expectedLoginOutput + expectedChangePasswordOutput, baos.toString());
assertEquals( expectedChangePasswordOutput, baos.toString());
assertEquals("foo", connectionConfig.username());
assertEquals("newpass", connectionConfig.password());
assertNull(connectionConfig.newPassword());
Expand All @@ -178,7 +167,7 @@ public void promptsOnPasswordChangeRequired() throws Exception {
} else {
// in 3.x we do not get credentials expired exception on connection, but when we try to access data
String expectedChangePasswordOutput = format( "username: foo%npassword: ****%n" );
assertEquals(expectedLoginOutput + expectedChangePasswordOutput, baos.toString());
assertEquals( expectedChangePasswordOutput, baos.toString());
assertEquals("foo", connectionConfig.username());
assertEquals("pass", connectionConfig.password());

Expand All @@ -189,6 +178,61 @@ public void promptsOnPasswordChangeRequired() throws Exception {
}
}

@Test
public void allowUserToUpdateExpiredPasswordInteractivelyWithoutBeingPrompted() throws Exception {
//given a user that require a password change
int majorVersion = getVersionAndCreateUserWithPasswordChangeRequired();

//when the user attempts a non-interactive password update
assumeTrue(majorVersion >= 4 );
baos.reset();
assertEquals( EXIT_SUCCESS, main.runShell( args( SYSTEM_DB_NAME, "foo", "pass",
"ALTER CURRENT USER SET PASSWORD from \"pass\" to \"pass2\";" ), shell, mock( Logger.class ) ) );
//we shouldn't ask for a new password
assertEquals( "", baos.toString() );

//then the new user should be able to successfully connect, and run a command
assertEquals( format( "n%n42%n" ),
executeNonInteractively( args( DEFAULT_DEFAULT_DB_NAME,
"foo", "pass2", "RETURN 42 AS n" ) ) );
}

@Test
public void shouldFailIfNonInteractivelySettingPasswordOnNonSystemDb() throws Exception {
//given a user that require a password change
int majorVersion = getVersionAndCreateUserWithPasswordChangeRequired();

//when
assumeTrue( majorVersion >= 4 );

//then
assertEquals( EXIT_FAILURE, main.runShell( args( DEFAULT_DEFAULT_DB_NAME, "foo", "pass",
"ALTER CURRENT USER SET PASSWORD from \"pass\" to \"pass2\";" ), shell, mock( Logger.class ) ) );
}

@Test
public void shouldBePromptedIfRunningNonInteractiveCypherThatDoesntUpdatePassword() throws Exception {
//given a user that require a password change
int majorVersion = getVersionAndCreateUserWithPasswordChangeRequired();

//when
assumeTrue( majorVersion >= 4 );

//when interactively asked for a password use this
inputBuffer.put( String.format( "pass2%n" ).getBytes() );
baos.reset();
assertEquals( EXIT_SUCCESS, main.runShell( args( DEFAULT_DEFAULT_DB_NAME, "foo", "pass",
"MATCH (n) RETURN n" ), shell, mock( Logger.class ) ) );

//then should ask for a new password
assertEquals( format( "Password change required%nnew password: *****%n" ), baos.toString() );

//then the new user should be able to successfully connect, and run a command
assertEquals( format( "n%n42%n" ),
executeNonInteractively( args( DEFAULT_DEFAULT_DB_NAME,
"foo", "pass2", "RETURN 42 AS n" ) ) );
}

@Test
public void doesNotPromptToStdOutOnWrongAuthenticationIfOutputRedirected() throws Exception {
// when
Expand Down Expand Up @@ -296,10 +340,15 @@ public void shouldReadMultipleCypherStatementsFromFile() throws Exception {

@Test
public void shouldFailIfInputFileDoesntExist() throws Exception {
// expect
exception.expect( FileNotFoundException.class);
exception.expectMessage( "what.cypher (No such file or directory)" );
executeFileNonInteractively("what.cypher");
//given
ByteArrayOutputStream out = new ByteArrayOutputStream();
Logger logger = new AnsiLogger( false, Format.VERBOSE, new PrintStream( out ), new PrintStream( out ));

//when
executeFileNonInteractively("what.cypher", logger);

//then
assertEquals( format("what.cypher (No such file or directory)%n"), out.toString());
}

@Test
Expand Down Expand Up @@ -411,7 +460,7 @@ public void doesNotStartWhenDefaultDatabaseUnavailableIfInteractive() throws Exc
assertEquals("neo", connectionConfig.password());

// Stop the default database
shell.execute(":use " + DatabaseManager.SYSTEM_DB_NAME);
shell.execute(":use " + SYSTEM_DB_NAME);
shell.execute("STOP DATABASE " + DatabaseManager.DEFAULT_DEFAULT_DB_NAME);

try {
Expand Down Expand Up @@ -453,7 +502,7 @@ public void startsAgainstSystemDatabaseWhenDefaultDatabaseUnavailableIfInteracti
assertEquals("neo", connectionConfig.password());

// Stop the default database
shell.execute(":use " + DatabaseManager.SYSTEM_DB_NAME);
shell.execute(":use " + SYSTEM_DB_NAME);
shell.execute("STOP DATABASE " + DatabaseManager.DEFAULT_DEFAULT_DB_NAME);

try {
Expand Down Expand Up @@ -502,7 +551,7 @@ public void switchingToUnavailableDatabaseIfInteractive() throws Exception {
assertEquals("neo", connectionConfig.password());

// Stop the default database
shell.execute(":use " + DatabaseManager.SYSTEM_DB_NAME);
shell.execute(":use " + SYSTEM_DB_NAME);
shell.execute("STOP DATABASE " + DatabaseManager.DEFAULT_DEFAULT_DB_NAME);

try {
Expand Down Expand Up @@ -540,7 +589,7 @@ public void switchingToUnavailableDefaultDatabaseIfInteractive() throws Exceptio
assertEquals("neo", connectionConfig.password());

// Stop the default database
shell.execute(":use " + DatabaseManager.SYSTEM_DB_NAME);
shell.execute(":use " + SYSTEM_DB_NAME);
shell.execute("STOP DATABASE " + DatabaseManager.DEFAULT_DEFAULT_DB_NAME);

try {
Expand All @@ -554,23 +603,29 @@ public void switchingToUnavailableDefaultDatabaseIfInteractive() throws Exceptio
}
}

private String executeFileNonInteractively(String filename) throws Exception {
private String executeFileNonInteractively(String filename) {
return executeFileNonInteractively(filename, mock(Logger.class));
}

private String executeFileNonInteractively(String filename, Logger logger) throws Exception
{
private String executeFileNonInteractively(String filename, Logger logger) {
CliArgs cliArgs = new CliArgs();
cliArgs.setUsername( USER, "" );
cliArgs.setPassword( PASSWORD, "" );
cliArgs.setInputFilename(filename);

return executeNonInteractively( cliArgs, logger );
}

private String executeNonInteractively(CliArgs cliArgs) {
return executeNonInteractively(cliArgs, mock(Logger.class));
}

private String executeNonInteractively(CliArgs cliArgs, Logger logger)
{
ToStringLinePrinter linePrinter = new ToStringLinePrinter();
ShellAndConnection sac = getShell( cliArgs, linePrinter );
CypherShell shell = sac.shell;
ConnectionConfig connectionConfig = sac.connectionConfig;
main.connectMaybeInteractively( shell, connectionConfig, true, true );
ShellRunner shellRunner = ShellRunner.getShellRunner(cliArgs, shell, logger, connectionConfig);
shellRunner.runUntilEnd();

main.runShell(cliArgs, shell, logger);
return linePrinter.result();
}

Expand Down Expand Up @@ -626,4 +681,26 @@ private void exit( CypherShell shell ) throws CommandException
//do nothing
}
}

private CliArgs args(String db, String user, String pass, String cypher)
{
CliArgs cliArgs = new CliArgs();
cliArgs.setUsername( user, "" );
cliArgs.setPassword( pass, "" );
cliArgs.setDatabase( db );
cliArgs.setCypher( cypher );
return cliArgs;
}

private int getVersionAndCreateUserWithPasswordChangeRequired() throws Exception {
shell.setCommandHelper( new CommandHelper( mock( Logger.class ), Historian.empty, shell ) );

main.connectMaybeInteractively( shell, connectionConfig, true, true );
String expectedLoginOutput = format( "username: neo4j%npassword: ***%n" );
assertEquals( expectedLoginOutput, baos.toString() );
ensureUser();
int majorVersion = majorVersion( shell.getServerVersion() );
shell.disconnect();
return majorVersion;
}
}
2 changes: 1 addition & 1 deletion cypher-shell/src/main/java/org/neo4j/shell/ConnectionConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public void setPassword(@Nonnull String password) {
this.password = password;
}

public void setNewPassword(@Nonnull String password) {
public void setNewPassword( String password) {
this.newPassword = password;
}

Expand Down
15 changes: 12 additions & 3 deletions cypher-shell/src/main/java/org/neo4j/shell/Connector.java
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
package org.neo4j.shell;

import org.neo4j.shell.exception.CommandException;

import javax.annotation.Nonnull;

import org.neo4j.function.ThrowingAction;
import org.neo4j.shell.exception.CommandException;

/**
* An object with the ability to connect and disconnect.
*/
Expand All @@ -18,7 +19,15 @@ public interface Connector {
*
* @throws CommandException if connection failed
*/
void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandException;
default void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandException {
connect( connectionConfig, null );
}

/**
*
* @throws CommandException if connection failed
*/
void connect( @Nonnull ConnectionConfig connectionConfig, ThrowingAction<CommandException> action) throws CommandException;

/**
* Returns the version of Neo4j which the shell is connected to. If the version is before 3.1.0-M09, or we are not
Expand Down
19 changes: 11 additions & 8 deletions cypher-shell/src/main/java/org/neo4j/shell/CypherShell.java
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
package org.neo4j.shell;

import java.util.List;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nonnull;

import org.neo4j.driver.exceptions.DiscoveryException;
import org.neo4j.driver.exceptions.Neo4jException;
import org.neo4j.driver.exceptions.ServiceUnavailableException;
import org.neo4j.function.ThrowingAction;
import org.neo4j.shell.commands.Command;
import org.neo4j.shell.commands.CommandExecutable;
import org.neo4j.shell.commands.CommandHelper;
Expand All @@ -14,12 +21,6 @@
import org.neo4j.shell.state.BoltResult;
import org.neo4j.shell.state.BoltStateHandler;

import javax.annotation.Nonnull;
import java.util.List;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
* A possibly interactive shell for evaluating cypher statements.
*/
Expand Down Expand Up @@ -137,10 +138,12 @@ protected void executeCmd(@Nonnull final CommandExecutable cmdExe) throws ExitEx
* Open a session to Neo4j
*
* @param connectionConfig
* @param command
*/
@Override
public void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandException {
boltStateHandler.connect(connectionConfig);
public void connect( @Nonnull ConnectionConfig connectionConfig,
ThrowingAction<CommandException> command) throws CommandException {
boltStateHandler.connect(connectionConfig, command );
}

@Nonnull
Expand Down
Loading

0 comments on commit 5494d30

Please sign in to comment.