Add precompiles for key generation and signing #1176

jberci · 2022-10-21T15:42:23Z

No description provided.

codecov · 2022-10-21T15:58:10Z

Codecov Report

Merging #1176 (7b1e85e) into main (cdb79f9) will increase coverage by 1.35%.
The diff coverage is 90.50%.

❗ Current head 7b1e85e differs from pull request most recent head be27674. Consider uploading reports for the commit be27674 to get more accurate results

@@            Coverage Diff             @@
##             main    #1176      +/-   ##
==========================================
+ Coverage   64.65%   66.01%   +1.35%     
==========================================
  Files         135      136       +1     
  Lines       12384    12960     +576     
==========================================
+ Hits         8007     8555     +548     
- Misses       4345     4373      +28     
  Partials       32       32

Impacted Files	Coverage Δ
runtime-sdk/src/crypto/signature/digests.rs	`78.26% <78.26%> (ø)`
runtime-sdk/src/crypto/signature/secp256k1.rs	`67.14% <84.37%> (+41.50%)`	⬆️
runtime-sdk/src/crypto/signature/mod.rs	`79.58% <87.09%> (+43.47%)`	⬆️
runtime-sdk/src/crypto/signature/ed25519.rs	`87.14% <92.10%> (+43.39%)`	⬆️
...ime-sdk/modules/evm/src/precompile/confidential.rs	`92.01% <93.27%> (+2.68%)`	⬆️
runtime-sdk/modules/evm/src/precompile/mod.rs	`89.13% <100.00%> (+0.75%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

nhynes

Thanks for this PR. I think the functionality overall looks solid, but it seems quite like there's some abstraction that describes all three variants in a way that ties them all together and reduces the need for tests.

One approach is to just have the one enum and its impl but have big ol' match arms that handle each case. This keeps things easy to understand and high performance with a slight decrease in readability.

Another approach create a trait called trait MemorySigner (or something) containing provided implementations of all of these methods with associated types type Signer: Signer and type Digest: Digest (so like let mut digest = Self::Digest::new()). You could then pass around a Box<dyn MemorySigner> for polymorphism. This comes with cleaner separation of implementations, but less efficiency (not that it really matters when you're only calling the thing once).

A third approach that mixes the two above and is quite like what you're already doing here: enum dispatch for performance but a trait to keep the APIs in sync. There's even a macro for it (enum_dispatch)! I'm not sure if this one works with associated types, though.

I'd suggest:

take a look at the different kinds of digests and signers you'll need (e.g., k256+sha3, ed25519_dalek+sha2) and see if they all implement a common trait (e.g., digest::Digest). If they do, you can simplify the implementation using associated types.
Try to collect everything into a trait and use Box<dyn Signer> for polymorphism to keep things simple. If you find that doesn't work, then you can bring back your enum but also bind the implementations together using a trait.
Look at enum_dispatch for your own edification. A tiny performance benefit isn't worth the supply chain risk of an extra dependency.

runtime-sdk/modules/evm/src/precompile/confidential.rs

runtime-sdk/src/crypto/signature/ed25519.rs

runtime-sdk/src/crypto/signature/secp256k1.rs

nhynes · 2022-11-23T08:29:01Z

runtime-sdk/modules/evm/src/precompile/utils.rs

+/// Length of an EVM word, in bytes.
+pub const WORD: usize = 32;
+
+pub fn round_up(what: usize) -> usize {


Suggested change

pub fn round_up(what: usize) -> usize {

pub fn round_up_u5(what: usize) -> usize {

is this a correct interpretation?

Depends on what you mean by the u5. The function should round the number up to the nearest multiple of 32, so the bottom 5 bits are cleared.

nhynes

This looks overall good. Just one main question, though: I see that the precompile is still about signing messages rather than signing digests using separate digest functions. Am I mistaken in thinking this? @kostko

runtime-sdk/src/crypto/signature/digests.rs

runtime-sdk/src/crypto/signature/ed25519.rs

runtime-sdk/modules/evm/src/precompile/confidential.rs

runtime-sdk/src/crypto/signature/mod.rs

runtime-sdk/modules/evm/src/precompile/confidential.rs

runtime-sdk/src/crypto/signature/digests.rs

Stale.

nhynes · 2022-12-13T16:57:05Z

runtime-sdk/modules/evm/src/precompile/confidential.rs

-const WORD: usize = 32;
+
+/// The cost of a key pair generation operation, per method.
+static KEYPAIR_GENERATE_BASE_COST: Lazy<HashMap<SignatureType, u64>> = Lazy::new(|| {


please inline this as an if ... else if ... else (or match)

nhynes · 2022-12-13T16:57:09Z

runtime-sdk/modules/evm/src/precompile/confidential.rs

+});
+
+/// The costs of a message signing operation.
+static SIGN_MESSAGE_COST: Lazy<HashMap<SignatureType, (u64, u64)>> = Lazy::new(|| {


please inline this as an if ... else if ... else (or match)

nhynes · 2022-12-13T16:58:50Z

runtime-sdk/src/crypto/signature/mod.rs

+impl SignatureType {
+    pub fn as_int(&self) -> u8 {
+        match self {
+            Self::Ed25519_Oasis => 0,


I suggest that 0 be nothing for the same reason protobuf makes the zeroth item Unknown (especially good for solidity where you can't test for presence).

nhynes · 2022-12-13T17:01:20Z

runtime-sdk/src/crypto/signature/ed25519.rs

+}
+
+impl super::Signer for MemorySigner {
+    fn new_from_seed(seed: &[u8]) -> Result<Self, Error> {


this isn't really so much of generate as derivePublicKey. Maybe this should invoke random_bytes with seed as the pers str?

nhynes · 2022-12-13T17:05:41Z

guess I was too late

kostko requested a review from nhynes October 21, 2022 15:43

jberci force-pushed the jberci/feature/signing-precompiles branch 4 times, most recently from ebf7060 to 50a301d Compare October 28, 2022 12:51

jberci marked this pull request as ready for review October 28, 2022 13:22

jberci requested review from kostko, pro-wh and ptrus as code owners October 28, 2022 13:22

This was referenced Oct 28, 2022

Add signature precompile descriptions oasisprotocol/docs#283

Merged

Add wrappers for signature precompiles to Sapphire library oasisprotocol/sapphire-paratime#80

Merged

nhynes previously requested changes Oct 31, 2022

View reviewed changes

jberci force-pushed the jberci/feature/signing-precompiles branch from 50a301d to 5e32ee7 Compare November 2, 2022 14:52

jberci force-pushed the jberci/feature/signing-precompiles branch from 5e32ee7 to 7a9b60b Compare November 9, 2022 16:02

jberci force-pushed the jberci/feature/signing-precompiles branch from 47fb41d to bdfffb0 Compare November 22, 2022 15:47

nhynes reviewed Nov 23, 2022

View reviewed changes

runtime-sdk/src/crypto/signature/digests.rs Outdated Show resolved Hide resolved

runtime-sdk/src/crypto/signature/ed25519.rs Show resolved Hide resolved

runtime-sdk/modules/evm/src/precompile/confidential.rs Outdated Show resolved Hide resolved

jberci force-pushed the jberci/feature/signing-precompiles branch 2 times, most recently from d66242c to 95b5c2d Compare December 6, 2022 22:19

kostko reviewed Dec 7, 2022

View reviewed changes

runtime-sdk/src/crypto/signature/mod.rs Outdated Show resolved Hide resolved

runtime-sdk/src/crypto/signature/mod.rs Outdated Show resolved Hide resolved

kostko mentioned this pull request Dec 9, 2022

runtime-sdk: add RNG #1037

Merged

nhynes force-pushed the jberci/feature/signing-precompiles branch from 95b5c2d to 6fdafee Compare December 10, 2022 08:20

jberci force-pushed the jberci/feature/signing-precompiles branch from 6fdafee to efbc21d Compare December 12, 2022 23:24

kostko reviewed Dec 13, 2022

View reviewed changes

runtime-sdk/modules/evm: Add precompiles for key generation and signing

be27674

jberci force-pushed the jberci/feature/signing-precompiles branch from 7b1e85e to be27674 Compare December 13, 2022 13:10

kostko approved these changes Dec 13, 2022

View reviewed changes

jberci merged commit c43daf9 into main Dec 13, 2022

jberci deleted the jberci/feature/signing-precompiles branch December 13, 2022 14:20

nhynes reviewed Dec 13, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add precompiles for key generation and signing #1176

Add precompiles for key generation and signing #1176

jberci commented Oct 21, 2022

codecov bot commented Oct 21, 2022 •

edited

Loading

nhynes left a comment

nhynes Nov 23, 2022 •

edited

Loading

jberci Nov 23, 2022

nhynes left a comment

nhynes Dec 13, 2022

nhynes Dec 13, 2022

nhynes Dec 13, 2022

nhynes Dec 13, 2022

nhynes commented Dec 13, 2022

	pub fn round_up(what: usize) -> usize {
	pub fn round_up_u5(what: usize) -> usize {

Add precompiles for key generation and signing #1176

Add precompiles for key generation and signing #1176

Conversation

jberci commented Oct 21, 2022

codecov bot commented Oct 21, 2022 • edited Loading

Codecov Report

nhynes left a comment

Choose a reason for hiding this comment

nhynes Nov 23, 2022 • edited Loading

Choose a reason for hiding this comment

jberci Nov 23, 2022

Choose a reason for hiding this comment

nhynes left a comment

Choose a reason for hiding this comment

nhynes Dec 13, 2022

Choose a reason for hiding this comment

nhynes Dec 13, 2022

Choose a reason for hiding this comment

nhynes Dec 13, 2022

Choose a reason for hiding this comment

nhynes Dec 13, 2022

Choose a reason for hiding this comment

nhynes commented Dec 13, 2022

codecov bot commented Oct 21, 2022 •

edited

Loading

nhynes Nov 23, 2022 •

edited

Loading