-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: Extension Signing request endpoint (#982)
* An extension sign endpoint /api/v1/eth2/ext/sign/:identifier which can be enabled with cli option --Xsigning-ext-enabled=true The cli option is associated with eth2 subcommand * build - fix docker goss test. Disable IPv6 in docker container for goss_wait test * build - store docker dgoss test results
- Loading branch information
1 parent
7f4b76b
commit 1c039cb
Showing
17 changed files
with
407 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
187 changes: 187 additions & 0 deletions
187
...java/tech/pegasys/web3signer/tests/signing/ProofOfValidationSigningExtAcceptanceTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| /* | ||
| * Copyright 2024 ConsenSys AG. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
| package tech.pegasys.web3signer.tests.signing; | ||
|
|
||
| import static io.restassured.http.ContentType.JSON; | ||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static tech.pegasys.teku.spec.SpecMilestone.DENEB; | ||
|
|
||
| import tech.pegasys.teku.bls.BLS; | ||
| import tech.pegasys.teku.bls.BLSKeyPair; | ||
| import tech.pegasys.teku.bls.BLSPublicKey; | ||
| import tech.pegasys.teku.bls.BLSSecretKey; | ||
| import tech.pegasys.teku.bls.BLSSignature; | ||
| import tech.pegasys.teku.spec.networks.Eth2Network; | ||
| import tech.pegasys.web3signer.core.service.http.SigningObjectMapperFactory; | ||
| import tech.pegasys.web3signer.core.service.http.handlers.signing.ProofOfValidationBody; | ||
| import tech.pegasys.web3signer.core.service.http.handlers.signing.SigningExtensionType; | ||
| import tech.pegasys.web3signer.dsl.signer.SignerConfigurationBuilder; | ||
| import tech.pegasys.web3signer.dsl.utils.MetadataFileHelpers; | ||
| import tech.pegasys.web3signer.signing.KeyType; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import io.restassured.http.ContentType; | ||
| import org.apache.tuweni.bytes.Bytes; | ||
| import org.apache.tuweni.bytes.Bytes32; | ||
| import org.apache.tuweni.units.bigints.UInt64; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.EnumSource; | ||
| import org.junit.jupiter.params.provider.ValueSource; | ||
|
|
||
| public class ProofOfValidationSigningExtAcceptanceTest extends SigningAcceptanceTestBase { | ||
|
|
||
| private static final String PRIVATE_KEY = | ||
| "3ee2224386c82ffea477e2adf28a2929f5c349165a4196158c7f3a2ecca40f35"; | ||
| private static final MetadataFileHelpers METADATA_FILE_HELPERS = new MetadataFileHelpers(); | ||
| private static final BLSSecretKey KEY = | ||
| BLSSecretKey.fromBytes(Bytes32.fromHexString(PRIVATE_KEY)); | ||
| private static final BLSKeyPair KEY_PAIR = new BLSKeyPair(KEY); | ||
| private static final BLSPublicKey PUBLIC_KEY = KEY_PAIR.getPublicKey(); | ||
| private static final ObjectMapper JSON_MAPPER = SigningObjectMapperFactory.createObjectMapper(); | ||
|
|
||
| @BeforeEach | ||
| void setup() { | ||
| final String configFilename = PUBLIC_KEY.toString().substring(2); | ||
| final Path keyConfigFile = testDirectory.resolve(configFilename + ".yaml"); | ||
| METADATA_FILE_HELPERS.createUnencryptedYamlFileAt(keyConfigFile, PRIVATE_KEY, KeyType.BLS); | ||
|
|
||
| setForkEpochsAndStartSigner( | ||
| new SignerConfigurationBuilder() | ||
| .withKeyStoreDirectory(testDirectory) | ||
| .withMode("eth2") | ||
| .withNetwork(Eth2Network.MINIMAL.configName()) | ||
| .withSigningExtEnabled(true), | ||
| DENEB); | ||
| } | ||
|
|
||
| @ParameterizedTest(name = "{index} - Testing Accept Media Type: {0}") | ||
| @EnumSource( | ||
| value = ContentType.class, | ||
| names = {"ANY", "JSON", "TEXT"}) | ||
| void extensionSigningData(final ContentType acceptMediaType) throws Exception { | ||
| final var signingExtensionBody = | ||
| new ProofOfValidationBody( | ||
| SigningExtensionType.PROOF_OF_VALIDATION, | ||
| "AT", | ||
| UInt64.valueOf(System.currentTimeMillis())); | ||
| final var payload = JSON_MAPPER.writeValueAsString(signingExtensionBody); | ||
|
|
||
| final var response = | ||
| signer.signExtensionPayload(PUBLIC_KEY.toString(), payload, acceptMediaType); | ||
|
|
||
| response.then().statusCode(200).contentType(JSON); | ||
|
|
||
| final var signatureResponse = | ||
| JSON_MAPPER.readValue(response.asByteArray(), ProofOfValidationResponse.class); | ||
|
|
||
| // assert that the signature is valid | ||
| final var blsSignature = | ||
| BLSSignature.fromBytesCompressed(Bytes.fromHexString(signatureResponse.signature)); | ||
|
|
||
| final var isValidBLSSig = | ||
| BLS.verify(PUBLIC_KEY, Bytes.wrap(payload.getBytes(UTF_8)), blsSignature); | ||
| assertThat(isValidBLSSig).isTrue(); | ||
|
|
||
| // assert that Base64 encoded payload is correct | ||
| assertThat(signatureResponse.payload) | ||
| .isEqualTo(Bytes.wrap(payload.getBytes(UTF_8)).toBase64String()); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @ValueSource(strings = {"1634025600000", "\"1634025600000\""}) | ||
| void timestampAsStringAndNumberResultsInValidSignature(final String timestampValue) | ||
| throws IOException { | ||
| final var payloadFormat = | ||
| """ | ||
| { | ||
| "type": "PROOF_OF_VALIDATION", | ||
| "platform": "AT", | ||
| "timestamp": %s | ||
| } | ||
| """; | ||
| final var payload = String.format(payloadFormat, timestampValue); | ||
|
|
||
| final var response = signer.signExtensionPayload(PUBLIC_KEY.toString(), payload, JSON); | ||
| response.then().statusCode(200).contentType(JSON); | ||
|
|
||
| final var signatureResponse = | ||
| JSON_MAPPER.readValue(response.asByteArray(), ProofOfValidationResponse.class); | ||
|
|
||
| // assert that the signature is valid | ||
| final var blsSignature = | ||
| BLSSignature.fromBytesCompressed(Bytes.fromHexString(signatureResponse.signature)); | ||
|
|
||
| final var isValidBLSSig = | ||
| BLS.verify(PUBLIC_KEY, Bytes.wrap(payload.getBytes(UTF_8)), blsSignature); | ||
| assertThat(isValidBLSSig).isTrue(); | ||
|
|
||
| // assert that Base64 encoded payload is correct | ||
| assertThat(signatureResponse.payload) | ||
| .isEqualTo(Bytes.wrap(payload.getBytes(UTF_8)).toBase64String()); | ||
| } | ||
|
|
||
| @Test | ||
| void invalidIdentifierCausesNotFound() throws Exception { | ||
| final ProofOfValidationBody proofOfValidationBody = | ||
| new ProofOfValidationBody( | ||
| SigningExtensionType.PROOF_OF_VALIDATION, | ||
| "AT", | ||
| UInt64.valueOf(System.currentTimeMillis())); | ||
| final String data = JSON_MAPPER.writeValueAsString(proofOfValidationBody); | ||
|
|
||
| signer.signExtensionPayload("0x1234", data, JSON).then().statusCode(404); | ||
| } | ||
|
|
||
| @ParameterizedTest(name = "{index} - Testing Invalid Body: {0}") | ||
| @ValueSource(strings = {"", "invalid", "{}", "{\"data\": \"invalid\"}"}) | ||
| void invalidBodyCausesBadRequestStatusCode(final String data) { | ||
| signer.signExtensionPayload(PUBLIC_KEY.toString(), data, JSON).then().statusCode(400); | ||
| } | ||
|
|
||
| @Test | ||
| void invalidSignExtensionTypeCausesBadRequestStatusCode() throws Exception { | ||
| final ProofOfValidationBody proofOfValidationBody = | ||
| new ProofOfValidationBody( | ||
| SigningExtensionType.PROOF_OF_VALIDATION, | ||
| "AT", | ||
| UInt64.valueOf(System.currentTimeMillis())); | ||
| var payload = JSON_MAPPER.writeValueAsString(proofOfValidationBody); | ||
| payload = payload.replace("PROOF_OF_VALIDATION", "INVALID_TYPE"); | ||
|
|
||
| signer.signExtensionPayload(PUBLIC_KEY.toString(), payload, JSON).then().statusCode(400); | ||
| } | ||
|
|
||
| @Test | ||
| void extraJsonFieldsCausesBadRequestStatusCode() throws Exception { | ||
| final ProofOfValidationBody proofOfValidationBody = | ||
| new ProofOfValidationBody( | ||
| SigningExtensionType.PROOF_OF_VALIDATION, | ||
| "AT", | ||
| UInt64.valueOf(System.currentTimeMillis())); | ||
| var payload = JSON_MAPPER.writeValueAsString(proofOfValidationBody); | ||
| payload = payload.replace("}", ",\"extraField\": \"extraValue\"}"); | ||
|
|
||
| signer.signExtensionPayload(PUBLIC_KEY.toString(), payload, JSON).then().statusCode(400); | ||
| } | ||
|
|
||
| record ProofOfValidationResponse( | ||
| @JsonProperty(value = "payload", required = true) String payload, | ||
| @JsonProperty(value = "signature", required = true) String signature) {} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.