Skip to content

Commit

Permalink
Added log level to security log
Browse files Browse the repository at this point in the history
  • Loading branch information
@fickludd
fickludd committed Oct 21, 2016
1 parent 2ccb074 commit 179d3a7
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 15 deletions.
6 changes: 6 additions & 0 deletions ...ty/src/main/java/org/neo4j/server/security/enterprise/configuration/SecuritySettings.java
View file
Expand Up @@ -27,6 +27,7 @@
import org.neo4j.graphdb.factory.Description;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.kernel.configuration.Internal;
import org.neo4j.logging.Level;

import static org.neo4j.kernel.configuration.Settings.BOOLEAN;
import static org.neo4j.kernel.configuration.Settings.BYTES;
Expand All @@ -39,6 +40,7 @@
import static org.neo4j.kernel.configuration.Settings.derivedSetting;
import static org.neo4j.kernel.configuration.Settings.max;
import static org.neo4j.kernel.configuration.Settings.min;
import static org.neo4j.kernel.configuration.Settings.options;
import static org.neo4j.kernel.configuration.Settings.setting;

/**
Expand Down Expand Up @@ -234,6 +236,10 @@ public class SecuritySettings
( logs ) -> new File( logs, "security.log" ),
PATH );

@Description("Security log level threshold.")
public static final Setting<Level> security_log_level = setting( "dbms.security.log_level",
options( Level.class ), "INFO" );

@Description( "Set to log successful authentication events." )
public static final Setting<Boolean> security_log_successful_authentication =
setting("dbms.security.log_successful_authentication", BOOLEAN, "true" );
Expand Down
8 changes: 4 additions & 4 deletions enterprise/security/src/main/java/org/neo4j/server/security/enterprise/log/SecurityLog.java
View file
Expand Up @@ -53,10 +53,10 @@ public SecurityLog( Config config, FileSystemAbstraction fileSystem, Executor ex
config.get( SecuritySettings.store_security_log_rotation_delay ),
config.get( SecuritySettings.store_security_log_max_archives ), executor );

this.inner = new AsyncLog(
event -> executor.execute( event::process ),
builder.toOutputStream( rotatingSupplier )
);
FormattedLog formattedLog = builder.toOutputStream( rotatingSupplier );
formattedLog.setLevel( config.get( SecuritySettings.security_log_level ) );

this.inner = new AsyncLog( event -> executor.execute( event::process ), formattedLog );
}

/* Only used for tests */
Expand Down
69 changes: 58 additions & 11 deletions ...rise/security/src/test/java/org/neo4j/server/security/enterprise/log/SecurityLogTest.java
View file
Expand Up @@ -19,7 +19,6 @@
*/
package org.neo4j.server.security.enterprise.log;

import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.Rule;
import org.junit.Test;
Expand All @@ -30,17 +29,22 @@

import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.logging.Level;
import org.neo4j.server.security.enterprise.configuration.SecuritySettings;
import org.neo4j.test.rule.fs.EphemeralFileSystemRule;

import static java.lang.String.format;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.array;
import static org.hamcrest.Matchers.containsString;
import static org.neo4j.helpers.collection.MapUtil.stringMap;

public class SecurityLogTest
{
@Rule
public EphemeralFileSystemRule fileSystemRule = new EphemeralFileSystemRule();

Config config = Config.defaults().augment(
private Config config = Config.defaults().augment(
stringMap( SecuritySettings.store_security_log_rotation_threshold.name(), "5",
SecuritySettings.store_security_log_rotation_delay.name(), "1ms" ) );

Expand All @@ -54,17 +58,61 @@ public void shouldRotateLog() throws IOException
FileSystemAbstraction fs = fileSystemRule.get();

File activeLogFile = config.get( SecuritySettings.security_log_filename );
MatcherAssert.assertThat( fs.fileExists( activeLogFile ), Matchers.equalTo( true ) );
MatcherAssert.assertThat( fs.fileExists( archive( 1 ) ), Matchers.equalTo( true ) );
MatcherAssert.assertThat( fs.fileExists( archive( 2 ) ), Matchers.equalTo( false ) );
assertThat( fs.fileExists( activeLogFile ), Matchers.equalTo( true ) );
assertThat( fs.fileExists( archive( 1 ) ), Matchers.equalTo( true ) );
assertThat( fs.fileExists( archive( 2 ) ), Matchers.equalTo( false ) );

String[] activeLines = readLogFile( fs, activeLogFile );
MatcherAssert.assertThat( activeLines.length, Matchers.equalTo( 1 ) );
MatcherAssert.assertThat( activeLines[0], Matchers.containsString( "line 2" ) );
assertThat( activeLines, array( containsString( "line 2" ) ) );

String[] archiveLines = readLogFile( fs, archive( 1 ) );
MatcherAssert.assertThat( archiveLines.length, Matchers.equalTo( 1 ) );
MatcherAssert.assertThat( archiveLines[0], Matchers.containsString( "line 1" ) );
assertThat( archiveLines, array( containsString( "line 1" ) ) );
}

@Test
public void shouldHonorLogLevel() throws Throwable
{
writeAllLevelsAndShutdown( withLogLevel( Level.DEBUG ), "debug" );
writeAllLevelsAndShutdown( withLogLevel( Level.INFO ), "info" );
writeAllLevelsAndShutdown( withLogLevel( Level.WARN ), "warn" );
writeAllLevelsAndShutdown( withLogLevel( Level.ERROR ), "error" );

FileSystemAbstraction fs = fileSystemRule.get();
File activeLogFile = config.get( SecuritySettings.security_log_filename );
String[] activeLines = readLogFile( fs, activeLogFile );
assertThat( activeLines, array(
containsString( "debug: debug line" ),
containsString( "debug: info line" ),
containsString( "debug: warn line" ),
containsString( "debug: error line" ),

containsString( "info: info line" ),
containsString( "info: warn line" ),
containsString( "info: error line" ),

containsString( "warn: warn line" ),
containsString( "warn: error line" ),

containsString( "error: error line" )
) );
}

private void writeAllLevelsAndShutdown( SecurityLog securityLog, String tag ) throws Throwable
{
securityLog.debug( format( "%s: debug line", tag ) );
securityLog.info( format( "%s: info line", tag ) );
securityLog.warn( format( "%s: warn line", tag ) );
securityLog.error( format( "%s: error line", tag ) );
securityLog.shutdown();
}

private SecurityLog withLogLevel( Level debug ) throws IOException
{
return new SecurityLog(
Config.defaults().augment( stringMap( SecuritySettings.security_log_level.name(), debug.name() ) ),
fileSystemRule.get(),
Runnable::run
);
}

private String[] readLogFile( FileSystemAbstraction fs, File activeLogFile ) throws IOException
Expand All @@ -78,7 +126,6 @@ private String[] readLogFile( FileSystemAbstraction fs, File activeLogFile ) thr

private File archive( int archiveNumber )
{
return new File( String.format( "%s.%d", config.get( SecuritySettings.security_log_filename ),
archiveNumber ) );
return new File( format( "%s.%d", config.get( SecuritySettings.security_log_filename ), archiveNumber ) );
}
}

0 comments on commit 179d3a7

Please sign in to comment.