Skip to content
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.

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

Retrieve node key pair information using admin API #635

Merged
merged 8 commits into from Feb 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,23 @@
import com.quorum.tessera.config.Peer;
import com.quorum.tessera.config.apps.AdminApp;
import com.quorum.tessera.core.config.ConfigService;
import com.quorum.tessera.encryption.PublicKey;
import com.quorum.tessera.node.PartyInfoService;
import com.quorum.tessera.node.model.Party;
import com.quorum.tessera.node.model.PartyInfo;

import javax.validation.Valid;
import javax.ws.rs.*;
import javax.ws.rs.core.GenericEntity;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
import java.net.URI;
import java.util.Base64;
import java.util.List;
import java.util.Objects;
import javax.ws.rs.core.GenericEntity;
import java.util.Set;
import java.util.stream.Collectors;

import static java.util.Collections.emptySet;
import static java.util.Collections.singleton;
Expand Down Expand Up @@ -85,4 +89,36 @@ public Response getPeers() {
}).build();
}

@GET
@Path("/keypairs/{publicKey}")
public Response getKeyPair(@PathParam("publicKey") String base64PublicKey) {

Base64.Decoder base64Decoder = Base64.getDecoder();

PublicKey publicKey = PublicKey.from(base64Decoder.decode(base64PublicKey));

Set<PublicKey> publicKeys = configService.getPublicKeys();

if(!publicKeys.contains(publicKey)) {
throw new NotFoundException("No key pair found with public key " + base64PublicKey);
}

PublicKeyResponse responseData = new PublicKeyResponse(base64PublicKey);

return Response.ok(responseData).build();
}

@GET
@Path("/keypairs")
public Response getKeyPairs() {
Set<PublicKey> publicKeys = configService.getPublicKeys();

List<PublicKeyResponse> responseData = publicKeys.stream()
.map(PublicKey::encodeToBase64)
.map(PublicKeyResponse::new)
.collect(Collectors.toList());

return Response.ok(new GenericEntity<List<PublicKeyResponse>>(responseData){}).build();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.quorum.tessera.admin;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;

@XmlAccessorType(XmlAccessType.FIELD)
class PublicKeyResponse {

@XmlElement
private String publicKey;
prd-fox marked this conversation as resolved.
Show resolved Hide resolved

//No args constructor required for jaxb marshalling
private PublicKeyResponse() {
}

PublicKeyResponse(String publicKey) {
this.publicKey = publicKey;
}

String getPublicKey() {
return this.publicKey;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.quorum.tessera.config.Peer;
import com.quorum.tessera.core.config.ConfigService;
import com.quorum.tessera.encryption.PublicKey;
import com.quorum.tessera.node.PartyInfoService;
import com.quorum.tessera.node.model.PartyInfo;
import org.junit.After;
Expand All @@ -11,8 +12,7 @@

import javax.ws.rs.NotFoundException;
import javax.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.List;
import java.util.*;

import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.assertThat;
Expand Down Expand Up @@ -107,7 +107,7 @@ public void getPeerIsSuccessful() {

@Test
public void getPeerNotFound() {
final Peer peer = new Peer("getPeerNoptFound");
final Peer peer = new Peer("getPeerNotFound");
when(configService.getPeers()).thenReturn(singletonList(peer));

final Throwable throwable = catchThrowable(() -> this.configResource.getPeer(2));
Expand All @@ -132,4 +132,82 @@ public void getPeers() {
verify(configService).getPeers();
}

@Test
public void getKeyPairResponseEntityIsReturnedIfNodeHasKeyPair() {
String base64Pub = "grQjd3dBp4qFs8/5Jdq7xjz++aUx/LXAqISFyPWaCRw=";

Base64.Decoder base64Decoder = Base64.getDecoder();
PublicKey publicKey = PublicKey.from(base64Decoder.decode(base64Pub));

Set<PublicKey> publicKeys = mock(Set.class);
when(publicKeys.contains(publicKey)).thenReturn(true);
when(configService.getPublicKeys()).thenReturn(publicKeys);

PublicKeyResponse expected = new PublicKeyResponse(base64Pub);

Response response = configResource.getKeyPair(base64Pub);

assertThat(response.getStatus()).isEqualTo(200);
assertThat(response.getEntity()).isEqualToComparingFieldByField(expected);

verify(configService).getPublicKeys();
}

@Test
public void getKeyPairIfNodeDoesNotHaveKeyPairThenExceptionThrown() {
String base64Pub = "grQjd3dBp4qFs8/5Jdq7xjz++aUx/LXAqISFyPWaCRw=";

Base64.Decoder base64Decoder = Base64.getDecoder();
PublicKey publicKey = PublicKey.from(base64Decoder.decode(base64Pub));

Set<PublicKey> publicKeys = mock(Set.class);
when(publicKeys.contains(publicKey)).thenReturn(false);
when(configService.getPublicKeys()).thenReturn(publicKeys);

Throwable ex = catchThrowable(() -> configResource.getKeyPair(base64Pub));

verify(configService).getPublicKeys();
assertThat(ex).isNotNull();
assertThat(ex).isInstanceOf(NotFoundException.class);
}

@Test
public void getKeyPairsReturnsListInResponseEntity() {
Base64.Decoder base64Decoder = Base64.getDecoder();

String keyA = "keyA";
String keyB = "keyB";

Set<PublicKey> publicKeys = new HashSet<>();
publicKeys.add(PublicKey.from(base64Decoder.decode(keyA)));
publicKeys.add(PublicKey.from(base64Decoder.decode(keyB)));

when(configService.getPublicKeys()).thenReturn(publicKeys);

final List<PublicKeyResponse> expected = new ArrayList<>();
PublicKeyResponse pkrA = new PublicKeyResponse(keyA);

PublicKeyResponse pkrB = new PublicKeyResponse(keyB);

expected.add(pkrA);
expected.add(pkrB);

Response response = configResource.getKeyPairs();

verify(configService).getPublicKeys();
assertThat(response.getStatus()).isEqualTo(200);
assertThat(response.getEntity()).isEqualToComparingFieldByFieldRecursively(expected);
}

@Test
public void getKeyPairsReturnsEmptyListIfNoKeyPairs() {
when(configService.getPublicKeys()).thenReturn(Collections.emptySet());

Response response = configResource.getKeyPairs();

verify(configService).getPublicKeys();
assertThat(response.getStatus()).isEqualTo(200);
assertThat(response.getEntity()).isEqualToComparingFieldByFieldRecursively(Collections.emptyList());
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package com.quorum.tessera.admin;

import org.junit.Test;

import static org.assertj.core.api.Assertions.assertThat;

public class PublicKeyResponseTest {

@Test
public void getter() {
String key = "key";
PublicKeyResponse pkr = new PublicKeyResponse(key);
assertThat(pkr.getPublicKey()).isEqualTo(key);
}

}
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package com.quorum.tessera.core.config;

import com.quorum.tessera.config.Peer;
import com.quorum.tessera.encryption.PublicKey;

import java.net.URI;
import java.util.List;
import java.util.Set;

public interface ConfigService {

Expand All @@ -15,5 +18,6 @@ public interface ConfigService {
boolean isDisablePeerDiscovery();

URI getServerUri();


Set<PublicKey> getPublicKeys();
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,27 @@
import com.quorum.tessera.config.Config;
import com.quorum.tessera.config.Peer;
import com.quorum.tessera.config.util.ConfigFileStore;
import com.quorum.tessera.enclave.Enclave;
import com.quorum.tessera.encryption.PublicKey;

import java.net.URI;
import java.util.List;
import java.util.Objects;
import java.util.Set;

public class ConfigServiceImpl implements ConfigService {

private final Config config;

private final Enclave enclave;

private final ConfigFileStore configFileStore;

public ConfigServiceImpl(Config initialConfig,ConfigFileStore configFileStore) {
public ConfigServiceImpl(Config initialConfig, Enclave enclave, ConfigFileStore configFileStore) {
this.config = Objects.requireNonNull(initialConfig);
this.enclave = Objects.requireNonNull(enclave);
this.configFileStore = Objects.requireNonNull(configFileStore);
}


@Override
public void addPeer(String url) {
Expand Down Expand Up @@ -46,4 +51,9 @@ public URI getServerUri() {
return config.getP2PServerConfig().getServerUri();
}

@Override
public Set<PublicKey> getPublicKeys() {
return this.enclave.getPublicKeys();
}

}
1 change: 1 addition & 0 deletions tessera-core/src/main/resources/tessera-core-spring.xml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@

<bean id="configService" class="com.quorum.tessera.core.config.ConfigServiceImpl">
<constructor-arg ref="config" />
<constructor-arg ref="enclave"/>
<constructor-arg>
<bean class="com.quorum.tessera.config.util.ConfigFileStore" factory-method="get" />
</constructor-arg>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
import com.quorum.tessera.config.Peer;
import com.quorum.tessera.config.ServerConfig;
import com.quorum.tessera.config.util.ConfigFileStore;
import java.net.URI;
import java.net.URISyntaxException;
import static org.assertj.core.api.Assertions.assertThat;
import com.quorum.tessera.enclave.Enclave;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.net.URI;
import java.net.URISyntaxException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.*;

public class ConfigServiceTest {
Expand All @@ -21,11 +24,14 @@ public class ConfigServiceTest {

private ConfigFileStore configFileStore;

private Enclave enclave;

@Before
public void onSetUp() {
config = mock(Config.class);
configFileStore = mock(ConfigFileStore.class);
configService = new ConfigServiceImpl(config, configFileStore);
enclave = mock(Enclave.class);
configService = new ConfigServiceImpl(config, enclave, configFileStore);
}

@After
Expand Down Expand Up @@ -86,4 +92,10 @@ public void getServerUri() throws URISyntaxException {
verify(config).getP2PServerConfig();
verify(serverConfig).getServerUri();
}

@Test
public void getPublicKeys() {
configService.getPublicKeys();
verify(enclave).getPublicKeys();
}
}