@ -22,28 +22,59 @@ import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.reset ;
import static org.mockito.Mockito.spy ;
import org.hyperledger.besu.config.StubGenesisConfigOptions ;
import org.hyperledger.besu.ethereum.api.handlers.TimeoutOptions ;
import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration ;
import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcHttpService ;
import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis ;
import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod ;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.filter.FilterManager ;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod ;
import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethodsFactory ;
import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.methods.WebSocketMethodsFactory ;
import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.subscription.SubscriptionManager ;
import org.hyperledger.besu.ethereum.api.query.BlockchainQueries ;
import org.hyperledger.besu.ethereum.blockcreation.PoWMiningCoordinator ;
import org.hyperledger.besu.ethereum.core.PrivacyParameters ;
import org.hyperledger.besu.ethereum.core.Synchronizer ;
import org.hyperledger.besu.ethereum.eth.EthProtocol ;
import org.hyperledger.besu.ethereum.eth.manager.EthPeers ;
import org.hyperledger.besu.ethereum.eth.manager.EthScheduler ;
import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool ;
import org.hyperledger.besu.ethereum.mainnet.MainnetProtocolSchedule ;
import org.hyperledger.besu.ethereum.p2p.network.P2PNetwork ;
import org.hyperledger.besu.ethereum.p2p.rlpx.wire.Capability ;
import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem ;
import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration ;
import org.hyperledger.besu.nat.NatService ;
import java.math.BigInteger ;
import java.net.URISyntaxException ;
import java.nio.file.Paths ;
import java.util.ArrayList ;
import java.util.Arrays ;
import java.util.Base64 ;
import java.util.Collection ;
import java.util.Collections ;
import java.util.HashMap ;
import java.util.HashSet ;
import java.util.List ;
import java.util.Map ;
import java.util.Optional ;
import java.util.Set ;
import com.google.common.base.Splitter ;
import com.google.common.collect.Lists ;
import io.vertx.core.AsyncResult ;
import io.vertx.core.Handler ;
import io.vertx.core.Vertx ;
import io.vertx.core.http.HttpClient ;
import io.vertx.core.http.HttpClientOptions ;
import io.vertx.core.http.HttpClientRequest ;
import io.vertx.core.http.HttpClientResponse ;
import io.vertx.core.http.HttpMethod ;
import io.vertx.core.http.WebSocketConnectOptions ;
import io.vertx.core.json.Json ;
import io.vertx.core.json.JsonArray ;
import io.vertx.core.json.JsonObject ;
import io.vertx.ext.auth.JWTOptions ;
@ -52,22 +83,44 @@ import io.vertx.ext.auth.jwt.JWTAuth;
import io.vertx.ext.unit.Async ;
import io.vertx.ext.unit.TestContext ;
import io.vertx.ext.unit.junit.VertxUnitRunner ;
import okhttp3.MediaType ;
import okhttp3.OkHttpClient ;
import org.assertj.core.api.Assertions ;
import org.junit.After ;
import org.junit.Before ;
import org.junit.ClassRule ;
import org.junit.Test ;
import org.junit.rules.TemporaryFolder ;
import org.junit.runner.RunWith ;
@RunWith ( VertxUnitRunner . class )
public class WebSocketServiceLoginTest {
private static final int VERTX_AWAIT_TIMEOUT_MILLIS = 10000 ;
@ClassRule public static final TemporaryFolder folder = new TemporaryFolder ( ) ;
private Vertx vertx ;
protected static Map < String , JsonRpcMethod > rpcMethods ;
protected static JsonRpcHttpService service ;
protected static OkHttpClient client ;
protected static String baseUrl ;
protected static final MediaType JSON = MediaType . parse ( "application/json; charset=utf-8" ) ;
protected static final String CLIENT_VERSION = "TestClientVersion/0.1.0" ;
protected static final BigInteger CHAIN_ID = BigInteger . valueOf ( 123 ) ;
protected static P2PNetwork peerDiscoveryMock ;
protected static BlockchainQueries blockchainQueries ;
protected static Synchronizer synchronizer ;
protected static final Collection < String > JSON_RPC_APIS =
Arrays . asList (
RpcApis . ETH . name ( ) , RpcApis . NET . name ( ) , RpcApis . WEB3 . name ( ) , RpcApis . ADMIN . name ( ) ) ;
protected static final List < String > NO_AUTH_METHODS =
Arrays . asList ( RpcMethod . NET_SERVICES . getMethodName ( ) ) ;
protected static JWTAuth jwtAuth ;
protected static final NatService natService = new NatService ( Optional . empty ( ) ) ;
private WebSocketConfiguration websocketConfiguration ;
private WebSocketRequestHandler webSocketRequestHandlerSpy ;
private WebSocketService websocketService ;
private HttpClient httpClient ;
protected static JWTAuth jwtAuth ;
@Before
public void before ( ) throws URISyntaxException {
@ -83,11 +136,51 @@ public class WebSocketServiceLoginTest {
websocketConfiguration . setAuthenticationEnabled ( true ) ;
websocketConfiguration . setAuthenticationCredentialsFile ( authTomlPath ) ;
websocketConfiguration . setHostsAllowlist ( Collections . singletonList ( "*" ) ) ;
websocketConfiguration . setRpcApisNoAuth ( new ArrayList < > ( NO_AUTH_METHODS ) ) ;
peerDiscoveryMock = mock ( P2PNetwork . class ) ;
blockchainQueries = mock ( BlockchainQueries . class ) ;
synchronizer = mock ( Synchronizer . class ) ;
final Set < Capability > supportedCapabilities = new HashSet < > ( ) ;
supportedCapabilities . add ( EthProtocol . ETH62 ) ;
supportedCapabilities . add ( EthProtocol . ETH63 ) ;
final StubGenesisConfigOptions genesisConfigOptions =
new StubGenesisConfigOptions ( ) . constantinopleBlock ( 0 ) . chainId ( CHAIN_ID ) ;
final Map < String , JsonRpcMethod > websocketMethods =
new WebSocketMethodsFactory (
new SubscriptionManager ( new NoOpMetricsSystem ( ) ) , new HashMap < > ( ) )
. methods ( ) ;
rpcMethods =
spy (
new JsonRpcMethodsFactory ( )
. methods (
CLIENT_VERSION ,
CHAIN_ID ,
genesisConfigOptions ,
peerDiscoveryMock ,
blockchainQueries ,
synchronizer ,
MainnetProtocolSchedule . fromConfig ( genesisConfigOptions ) ,
mock ( FilterManager . class ) ,
mock ( TransactionPool . class ) ,
mock ( PoWMiningCoordinator . class ) ,
new NoOpMetricsSystem ( ) ,
supportedCapabilities ,
Optional . empty ( ) ,
Optional . empty ( ) ,
JSON_RPC_APIS ,
mock ( PrivacyParameters . class ) ,
mock ( JsonRpcConfiguration . class ) ,
mock ( WebSocketConfiguration . class ) ,
mock ( MetricsConfiguration . class ) ,
natService ,
new HashMap < > ( ) ,
folder . getRoot ( ) . toPath ( ) ,
mock ( EthPeers . class ) ) ) ;
websocketMethods . putAll ( rpcMethods ) ;
webSocketRequestHandlerSpy =
spy (
new WebSocketRequestHandler (
@ -144,67 +237,67 @@ public class WebSocketServiceLoginTest {
@Test
public void loginWithGoodCredentials ( final TestContext context ) {
final Async async = context . async ( ) ;
Handler < AsyncResult < HttpClientResponse > > responseHandler =
response - > {
assertThat ( response . result ( ) . statusCode ( ) ) . isEqualTo ( 200 ) ;
assertThat ( response . result ( ) . statusMessage ( ) ) . isEqualTo ( "OK" ) ;
assertThat ( response . result ( ) . getHeader ( "Content-Type" ) ) . isNotNull ( ) ;
assertThat ( response . result ( ) . getHeader ( "Content-Type" ) ) . isEqualTo ( "application/json" ) ;
response
. result ( )
. bodyHandler (
buffer - > {
final String body = buffer . toString ( ) ;
assertThat ( body ) . isNotBlank ( ) ;
final JsonObject respBody = new JsonObject ( body ) ;
final String token = respBody . getString ( "token" ) ;
assertThat ( token ) . isNotNull ( ) ;
assertThat ( token ) . isNotEmpty ( ) ;
websocketService
. authenticationService
. get ( )
. getJwtAuthProvider ( )
. authenticate (
new JsonObject ( ) . put ( "token" , token ) ,
( r ) - > {
Assertions . assertThat ( r . succeeded ( ) ) . isTrue ( ) ;
final User user = r . result ( ) ;
user . isAuthorized (
"noauths" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isFalse ( ) ;
} ) ;
user . isAuthorized (
"fakePermission" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isTrue ( ) ;
} ) ;
user . isAuthorized (
"eth:subscribe" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isTrue ( ) ;
async . complete ( ) ;
} ) ;
} ) ;
} ) ;
} ;
Handler < AsyncResult < HttpClientRequest > > requestHandler =
request - > {
request . result ( ) . putHeader ( "Content-Type" , "application/json; charset=utf-8" ) ;
request . result ( ) . end ( "{\"username\":\"user\",\"password\":\"pegasys\"}" ) ;
request . result ( ) . send ( responseHandler ) ;
} ;
httpClient . request (
HttpMethod . POST ,
websocketConfiguration . getPort ( ) ,
websocketConfiguration . getHost ( ) ,
"/login" ,
request - > {
request . result ( ) . putHeader ( "Content-Type" , "application/json; charset=utf-8" ) ;
request . result ( ) . end ( "{\"username\":\"user\",\"password\":\"pegasys\"}" ) ;
request
. result ( )
. send (
response - > {
assertThat ( response . result ( ) . statusCode ( ) ) . isEqualTo ( 200 ) ;
assertThat ( response . result ( ) . statusMessage ( ) ) . isEqualTo ( "OK" ) ;
assertThat ( response . result ( ) . getHeader ( "Content-Type" ) ) . isNotNull ( ) ;
assertThat ( response . result ( ) . getHeader ( "Content-Type" ) )
. isEqualTo ( "application/json" ) ;
response
. result ( )
. bodyHandler (
buffer - > {
final String body = buffer . toString ( ) ;
assertThat ( body ) . isNotBlank ( ) ;
final JsonObject respBody = new JsonObject ( body ) ;
final String token = respBody . getString ( "token" ) ;
assertThat ( token ) . isNotNull ( ) ;
assertThat ( token ) . isNotEmpty ( ) ;
websocketService
. authenticationService
. get ( )
. getJwtAuthProvider ( )
. authenticate (
new JsonObject ( ) . put ( "token" , token ) ,
( r ) - > {
Assertions . assertThat ( r . succeeded ( ) ) . isTrue ( ) ;
final User user = r . result ( ) ;
user . isAuthorized (
"noauths" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isFalse ( ) ;
} ) ;
user . isAuthorized (
"fakePermission" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isTrue ( ) ;
} ) ;
user . isAuthorized (
"eth:subscribe" ,
( authed ) - > {
assertThat ( authed . succeeded ( ) ) . isTrue ( ) ;
assertThat ( authed . result ( ) ) . isTrue ( ) ;
async . complete ( ) ;
} ) ;
} ) ;
} ) ;
} ) ;
} ) ;
requestHandler ) ;
async . awaitSuccess ( VERTX_AWAIT_TIMEOUT_MILLIS ) ;
}
@ -240,6 +333,37 @@ public class WebSocketServiceLoginTest {
async . awaitSuccess ( VERTX_AWAIT_TIMEOUT_MILLIS ) ;
}
@Test
public void netServicesSucceedWithNoAuth ( final TestContext context ) {
final Async async = context . async ( ) ;
final String id = "123" ;
final String request =
"{\"jsonrpc\":\"2.0\",\"id\":" + Json . encode ( id ) + ",\"method\":\"net_services\"}" ;
final String expectedResponse = "{\"jsonrpc\":\"2.0\",\"id\":\"123\",\"result\":{}}" ;
WebSocketConnectOptions options = new WebSocketConnectOptions ( ) ;
options . setURI ( "/" ) ;
options . setHost ( websocketConfiguration . getHost ( ) ) ;
options . setPort ( websocketConfiguration . getPort ( ) ) ;
httpClient . webSocket (
options ,
webSocket - > {
webSocket . result ( ) . writeTextMessage ( request ) ;
webSocket
. result ( )
. handler (
buffer - > {
context . assertEquals ( expectedResponse , buffer . toString ( ) ) ;
async . complete ( ) ;
} ) ;
} ) ;
async . awaitSuccess ( VERTX_AWAIT_TIMEOUT_MILLIS ) ;
}
@Test
public void websocketServiceWithGoodHeaderAuthenticationToken ( final TestContext context ) {
final Async async = context . async ( ) ;
Frank Li
3 years ago
committed by
GitHub