Skip to content

Keep Neo4j credentials out of query failure messages #1314

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

Open
malberts wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Keep Neo4j credentials out of query failure messages #1314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions src/GraphDatabasePlugins/Neo4j/Application/Neo4jQueryService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use ProfessionalWiki\NeoWiki\GraphDatabasePlugins\Neo4j\Application\Exception\QueryException;
use ProfessionalWiki\NeoWiki\GraphDatabasePlugins\Neo4j\Application\Exception\QueryTimeoutException;
use ProfessionalWiki\NeoWiki\GraphDatabasePlugins\Neo4j\Application\Exception\WriteQueryRejectedException;
use ProfessionalWiki\NeoWiki\Domain\GraphDatabase\BackendFailureMessage;
use ProfessionalWiki\NeoWiki\GraphDatabasePlugins\Neo4j\Persistence\Neo4jResultNormalizer;
use Throwable;

Expand Down Expand Up @@ -41,7 +42,11 @@ public function execute( Neo4jQueryRequest $request ): Neo4jQueryResult {
// not a misleading "backend unavailable".
throw $this->translateNeo4jException( $e );
} catch ( Throwable $e ) {
throw new BackendUnavailableException( $e->getMessage(), 0, $e );
throw new BackendUnavailableException(
BackendFailureMessage::withoutCredentials( $e->getMessage() ),
0,
$e
);
}

if ( !$allowed ) {
Expand All @@ -59,7 +64,11 @@ public function execute( Neo4jQueryRequest $request ): Neo4jQueryResult {
} catch ( Neo4jException $e ) {
throw $this->translateNeo4jException( $e );
} catch ( Throwable $e ) {
throw new BackendUnavailableException( $e->getMessage(), 0, $e );
throw new BackendUnavailableException(
BackendFailureMessage::withoutCredentials( $e->getMessage() ),
0,
$e
);
}

$durationMs = (int)( microtime( true ) * 1000 ) - $startedAt;
Expand Down
45 changes: 45 additions & 0 deletions tests/phpunit/GraphDatabasePlugins/Neo4j/Application/Neo4jQueryServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@
*/
class Neo4jQueryServiceTest extends TestCase {

/**
* How the driver reports an unreachable server: by quoting the Bolt URI it dialed, credentials
* included. The query surfaces hand this message to callers, anonymous ones included.
*/
private const string UNREACHABLE_SERVER_MESSAGE =
"Cannot connect to any server on alias: default with Uris: ('bolt://neowiki_read:S3cr3t@graph.example:7687')";

public function testReturnsRowsAsListWithColumnsFromProtocolKeys(): void {
$service = $this->newService(
$this->stubEngineWithRows( [
Expand Down Expand Up @@ -207,6 +214,44 @@ public function queryIsAllowed( string $cypher ): bool {
$service->execute( $this->newRequest( 'MATCH (n) RETURN n' ) );
}

public function testEngineBackendFailureDoesNotCarryCredentials(): void {
$service = $this->newService(
$this->stubEngineThrowing( new RuntimeException( self::UNREACHABLE_SERVER_MESSAGE ) )
);

$message = $this->executeAndCatch( $service )->getMessage();

$this->assertStringNotContainsString( 'S3cr3t', $message );
$this->assertStringContainsString( 'graph.example', $message );
}

public function testValidatorBackendFailureDoesNotCarryCredentials(): void {
$throwingValidator = new class( self::UNREACHABLE_SERVER_MESSAGE ) implements CypherQueryValidator {
public function __construct( private string $message ) {
}

public function queryIsAllowed( string $cypher ): bool {
throw new RuntimeException( $this->message );
}
};
$service = $this->newService( $this->stubEngineWithRows( [] ), validator: $throwingValidator );

$message = $this->executeAndCatch( $service )->getMessage();

$this->assertStringNotContainsString( 'S3cr3t', $message );
$this->assertStringContainsString( 'graph.example', $message );
}

private function executeAndCatch( Neo4jQueryService $service ): BackendUnavailableException {
try {
$service->execute( $this->newRequest( 'MATCH (n) RETURN n' ) );
} catch ( BackendUnavailableException $e ) {
return $e;
}

$this->fail( 'Expected a BackendUnavailableException.' );
}

public function testValidatorNeo4jSyntaxErrorBecomesCypherSyntaxException(): void {
$throwingValidator = new class implements CypherQueryValidator {
public function queryIsAllowed( string $cypher ): bool {
Expand Down