@ -21,7 +21,6 @@ import org.hyperledger.besu.pki.keystore.HardwareKeyStoreWrapper;
import org.hyperledger.besu.pki.keystore.KeyStoreWrapper ; import org.hyperledger.besu.pki.keystore.KeyStoreWrapper ;
import org.hyperledger.besu.pki.keystore.SoftwareKeyStoreWrapper ; import org.hyperledger.besu.pki.keystore.SoftwareKeyStoreWrapper ;
import java.io.IOException ;
import java.net.InetSocketAddress ; import java.net.InetSocketAddress ;
import java.nio.file.Path ; import java.nio.file.Path ;
import java.util.Arrays ; import java.util.Arrays ;
@ -45,16 +44,16 @@ import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel ; import io.netty.channel.socket.nio.NioSocketChannel ;
import io.netty.handler.ssl.SslContext ; import io.netty.handler.ssl.SslContext ;
import io.netty.handler.ssl.SslHandler ; import io.netty.handler.ssl.SslHandler ;
import org.junit.After ; import org.junit.Assume ;
import org.junit.Before ; import org.junit.jupiter.api.AfterEach ;
import org.junit.Test ; import org.junit.jupiter.api.BeforeEach ;
import org.junit.runner.RunWith ; import org.junit.jupiter.api.condition.OS ;
import org.junit.runners.Parameterized ; import org.junit.jupiter.params.ParameterizedTest ;
import org.junit.jupiter.params.provider.MethodSource ;
import org.slf4j.Logger ; import org.slf4j.Logger ;
import org.slf4j.LoggerFactory ; import org.slf4j.LoggerFactory ;
@RunWith ( Parameterized . class ) class TLSContextFactoryTest {
public class TLSContextFactoryTest {
private static final String JKS = "JKS" ; private static final String JKS = "JKS" ;
private static final String validKeystorePassword = "test123" ; private static final String validKeystorePassword = "test123" ;
@ -86,19 +85,36 @@ public class TLSContextFactoryTest {
private Server server ; private Server server ;
private Client client ; private Client client ;
@Parameterized.Parameter public String keyStoreWrapperDescription ; static Collection < Object [ ] > hardwareKeysData ( ) {
return Arrays . asList (
@Parameterized.Parameter ( 1 ) new Object [ ] [ ] {
public boolean testSuccess ; {
"PKCS11 serverPartner1Client1 -> JKS clientPartner2Client1 SuccessfulConnection" ,
@Parameterized.Parameter ( 2 ) true ,
public KeyStoreWrapper serverKeyStoreWrapper ; getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
@Parameterized.Parameter ( 3 ) partner2client1JKSKeystore , partner2client1JKSTruststore , partner2client1CRL )
public KeyStoreWrapper clientKeyStoreWrapper ; } ,
{
"PKCS11 serverPartner1Client1 -> JKS clientInvalidPartner1Client1 FailedConnection" ,
false ,
getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
invalidPartner1client1JKSKeystore ,
invalidPartner1client1JKSTruststore ,
invalidPartner1client1CRL )
} ,
{
"PKCS11 serverPartner1Client1 -> JKS clientPartner1Client2rvk FailedConnection" ,
false ,
getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
partner1client2rvkJKSKeystore , partner1client2rvkJKSTruststore , null )
} ,
} ) ;
}
@Parameterized.Parameters ( name = "{index}: {0}" ) static Collection < Object [ ] > softwareKeysData ( ) {
public static Collection < Object [ ] > data ( ) {
return Arrays . asList ( return Arrays . asList (
new Object [ ] [ ] { new Object [ ] [ ] {
{ {
@ -117,13 +133,6 @@ public class TLSContextFactoryTest {
getSoftwareKeyStoreWrapper ( getSoftwareKeyStoreWrapper (
partner1client1JKSKeystore , partner1client1JKSTruststore , partner1client1CRL ) partner1client1JKSKeystore , partner1client1JKSTruststore , partner1client1CRL )
} , } ,
{
"PKCS11 serverPartner1Client1 -> JKS clientPartner2Client1 SuccessfulConnection" ,
true ,
getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
partner2client1JKSKeystore , partner2client1JKSTruststore , partner2client1CRL )
} ,
{ {
"JKS serverPartner1Client1 -> JKS clientInvalidPartner1Client1 FailedConnection" , "JKS serverPartner1Client1 -> JKS clientInvalidPartner1Client1 FailedConnection" ,
false , false ,
@ -144,15 +153,6 @@ public class TLSContextFactoryTest {
getSoftwareKeyStoreWrapper ( getSoftwareKeyStoreWrapper (
partner1client1JKSKeystore , partner1client1JKSTruststore , partner1client1CRL ) partner1client1JKSKeystore , partner1client1JKSTruststore , partner1client1CRL )
} , } ,
{
"PKCS11 serverPartner1Client1 -> JKS clientInvalidPartner1Client1 FailedConnection" ,
false ,
getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
invalidPartner1client1JKSKeystore ,
invalidPartner1client1JKSTruststore ,
invalidPartner1client1CRL )
} ,
{ {
"JKS serverPartner1Client2rvk -> JKS clientPartner2Client1 FailedConnection" , "JKS serverPartner1Client2rvk -> JKS clientPartner2Client1 FailedConnection" ,
false , false ,
@ -169,13 +169,6 @@ public class TLSContextFactoryTest {
getSoftwareKeyStoreWrapper ( getSoftwareKeyStoreWrapper (
partner1client2rvkJKSKeystore , partner1client2rvkJKSTruststore , null ) partner1client2rvkJKSKeystore , partner1client2rvkJKSTruststore , null )
} , } ,
{
"PKCS11 serverPartner1Client1 -> JKS clientPartner1Client2rvk FailedConnection" ,
false ,
getHardwareKeyStoreWrapper ( partner1client1PKCS11Config , partner1client1CRL ) ,
getSoftwareKeyStoreWrapper (
partner1client2rvkJKSKeystore , partner1client2rvkJKSTruststore , null )
} ,
{ {
"JKS serverPartner2Client2rvk -> JKS clientPartner1Client1 FailedConnection" , "JKS serverPartner2Client2rvk -> JKS clientPartner1Client1 FailedConnection" ,
false , false ,
@ -195,11 +188,11 @@ public class TLSContextFactoryTest {
} ) ; } ) ;
} }
@Before @BeforeEach
public void init ( ) throws IOException , InterruptedException { } void init ( ) { }
@After @AfterEach
public void tearDown ( ) { void tearDown ( ) {
if ( client ! = null ) { if ( client ! = null ) {
client . stop ( ) ; client . stop ( ) ;
} }
@ -217,7 +210,13 @@ public class TLSContextFactoryTest {
try { try {
return new HardwareKeyStoreWrapper ( return new HardwareKeyStoreWrapper (
validKeystorePassword , toPath ( config ) , toPath ( crlLocation ) ) ; validKeystorePassword , toPath ( config ) , toPath ( crlLocation ) ) ;
} catch ( Exception e ) { } catch ( final Exception e ) {
if ( OS . MAC . isCurrentOs ( ) ) {
// nss3 is difficult to setup on mac correctly, don't let it break unit tests for dev
// machines.
Assume . assumeNoException ( "Failed to initialize hardware keystore" , e ) ;
}
// Not a mac, probably a production build. Full failure.
throw new PkiException ( "Failed to initialize hardware keystore" , e ) ; throw new PkiException ( "Failed to initialize hardware keystore" , e ) ;
} }
} }
@ -233,13 +232,38 @@ public class TLSContextFactoryTest {
toPath ( trustStore ) , toPath ( trustStore ) ,
null , null ,
toPath ( crl ) ) ; toPath ( crl ) ) ;
} catch ( Exception e ) { } catch ( final Exception e ) {
throw new PkiException ( "Failed to initialize software keystore" , e ) ; throw new PkiException ( "Failed to initialize software keystore" , e ) ;
} }
} }
@Test @ParameterizedTest ( name = "{index}: {0}" )
public void testConnection ( ) throws Exception { @MethodSource ( "softwareKeysData" )
void testConnectionSoftwareKeys (
final String ignoredTestDescription ,
final boolean testSuccess ,
final KeyStoreWrapper serverKeyStoreWrapper ,
final KeyStoreWrapper clientKeyStoreWrapper )
throws Exception {
testConnection ( testSuccess , serverKeyStoreWrapper , clientKeyStoreWrapper ) ;
}
@ParameterizedTest ( name = "{index}: {0}" )
@MethodSource ( "hardwareKeysData" )
void testConnectionHardwareKeys (
final String ignoredTestDescription ,
final boolean testSuccess ,
final KeyStoreWrapper serverKeyStoreWrapper ,
final KeyStoreWrapper clientKeyStoreWrapper )
throws Exception {
testConnection ( testSuccess , serverKeyStoreWrapper , clientKeyStoreWrapper ) ;
}
private void testConnection (
final boolean testSuccess ,
final KeyStoreWrapper serverKeyStoreWrapper ,
final KeyStoreWrapper clientKeyStoreWrapper )
throws Exception {
final CountDownLatch serverLatch = new CountDownLatch ( MAX_NUMBER_MESSAGES ) ; final CountDownLatch serverLatch = new CountDownLatch ( MAX_NUMBER_MESSAGES ) ;
final CountDownLatch clientLatch = new CountDownLatch ( MAX_NUMBER_MESSAGES ) ; final CountDownLatch clientLatch = new CountDownLatch ( MAX_NUMBER_MESSAGES ) ;
server = startServer ( serverKeyStoreWrapper , serverLatch ) ; server = startServer ( serverKeyStoreWrapper , serverLatch ) ;
@ -255,7 +279,7 @@ public class TLSContextFactoryTest {
client . getChannelFuture ( ) . channel ( ) . writeAndFlush ( Unpooled . copyInt ( 0 ) ) . sync ( ) ; client . getChannelFuture ( ) . channel ( ) . writeAndFlush ( Unpooled . copyInt ( 0 ) ) . sync ( ) ;
serverLatch . await ( 2 , TimeUnit . SECONDS ) ; serverLatch . await ( 2 , TimeUnit . SECONDS ) ;
assertThat ( client . getChannelFuture ( ) . channel ( ) . isActive ( ) ) . isFalse ( ) ; assertThat ( client . getChannelFuture ( ) . channel ( ) . isActive ( ) ) . isFalse ( ) ;
} catch ( Exception e ) { } catch ( final Exception e ) {
// NOOP
// NOOP
} }
} }
@ -282,7 +306,7 @@ public class TLSContextFactoryTest {
private final String id ; private final String id ;
private final CountDownLatch latch ; private final CountDownLatch latch ;
public MessageHandler ( final String id , final CountDownLatch latch ) { MessageHandler ( final String id , final CountDownLatch latch ) {
this . id = id ; this . id = id ;
this . latch = latch ; this . latch = latch ;
} }
@ -312,7 +336,7 @@ public class TLSContextFactoryTest {
private ChannelFuture channelFuture ; private ChannelFuture channelFuture ;
private final EventLoopGroup group = new NioEventLoopGroup ( ) ; private final EventLoopGroup group = new NioEventLoopGroup ( ) ;
public ChannelFuture getChannelFuture ( ) { ChannelFuture getChannelFuture ( ) {
return channelFuture ; return channelFuture ;
} }
@ -335,7 +359,7 @@ public class TLSContextFactoryTest {
new ChannelInitializer < SocketChannel > ( ) { new ChannelInitializer < SocketChannel > ( ) {
@Override @Override
protected void initChannel ( final SocketChannel socketChannel ) throws Exception { protected void initChannel ( final SocketChannel socketChannel ) throws Exception {
SslContext sslContext = final SslContext sslContext =
TLSContextFactory . getInstance ( keystorePassword , keyStoreWrapper ) TLSContextFactory . getInstance ( keystorePassword , keyStoreWrapper )
. createNettyClientSslContext ( ) ; . createNettyClientSslContext ( ) ;
@ -346,11 +370,10 @@ public class TLSContextFactoryTest {
} }
} ) ; } ) ;
final ChannelFuture cf = b . connect ( "127.0.0.1" , this . port ) . sync ( ) ; this . channelFuture = b . connect ( "127.0.0.1" , this . port ) . sync ( ) ;
this . channelFuture = cf ;
} }
public void stop ( ) { void stop ( ) {
group . shutdownGracefully ( ) ; group . shutdownGracefully ( ) ;
} }
} }
@ -362,7 +385,6 @@ public class TLSContextFactoryTest {
private final CountDownLatch latch ; private final CountDownLatch latch ;
private Channel channel ; private Channel channel ;
private ChannelFuture channelFuture ;
private final EventLoopGroup parentGroup = new NioEventLoopGroup ( ) ; private final EventLoopGroup parentGroup = new NioEventLoopGroup ( ) ;
private final EventLoopGroup childGroup = new NioEventLoopGroup ( ) ; private final EventLoopGroup childGroup = new NioEventLoopGroup ( ) ;
@ -376,10 +398,6 @@ public class TLSContextFactoryTest {
this . latch = latch ; this . latch = latch ;
} }
public ChannelFuture getChannelFuture ( ) {
return channelFuture ;
}
void start ( ) throws Exception { void start ( ) throws Exception {
final ServerBootstrap sb = new ServerBootstrap ( ) ; final ServerBootstrap sb = new ServerBootstrap ( ) ;
sb . group ( parentGroup , childGroup ) sb . group ( parentGroup , childGroup )
@ -388,7 +406,7 @@ public class TLSContextFactoryTest {
new ChannelInitializer < SocketChannel > ( ) { new ChannelInitializer < SocketChannel > ( ) {
@Override @Override
public void initChannel ( final SocketChannel socketChannel ) throws Exception { public void initChannel ( final SocketChannel socketChannel ) throws Exception {
SslContext sslContext = final SslContext sslContext =
TLSContextFactory . getInstance ( keystorePassword , keyStoreWrapper ) TLSContextFactory . getInstance ( keystorePassword , keyStoreWrapper )
. createNettyServerSslContext ( ) ; . createNettyServerSslContext ( ) ;
final SslHandler sslHandler = sslContext . newHandler ( channel . alloc ( ) ) ; final SslHandler sslHandler = sslContext . newHandler ( channel . alloc ( ) ) ;
@ -400,11 +418,10 @@ public class TLSContextFactoryTest {
final ChannelFuture cf = sb . bind ( 0 ) . sync ( ) ; final ChannelFuture cf = sb . bind ( 0 ) . sync ( ) ;
this . channel = cf . channel ( ) ; this . channel = cf . channel ( ) ;
this . channelFuture = cf ;
this . port = ( ( InetSocketAddress ) channel . localAddress ( ) ) . getPort ( ) ; this . port = ( ( InetSocketAddress ) channel . localAddress ( ) ) . getPort ( ) ;
} }
public void stop ( ) { void stop ( ) {
childGroup . shutdownGracefully ( ) ; childGroup . shutdownGracefully ( ) ;
parentGroup . shutdownGracefully ( ) ; parentGroup . shutdownGracefully ( ) ;
} }
Danno Ferrin
3 years ago
committed by
GitHub