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.

Sign up for GitHub

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

fix: add hook for ed decompress #1829

Merged
merged 4 commits into from
Nov 29, 2024
Merged

fix: add hook for ed decompress #1829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59e5a09
fix: add hook for ed decompress
nhtyy Nov 28, 2024
ff7bf7d
fix compile
nhtyy Nov 28, 2024
b378643
fix: prep versions for release
nhtyy Nov 29, 2024
8cb9dad
fix: copy bytes
nhtyy Nov 29, 2024
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
81 changes: 24 additions & 57 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 21 additions & 21 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[workspace.package]
version = "3.3.0"
version = "3.4.0"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/succinctlabs/sp1"
Expand Down Expand Up @@ -47,26 +47,26 @@ debug-assertions = true

[workspace.dependencies]
# sp1
sp1-build = { path = "crates/build", version = "3.3.0" }
sp1-cli = { path = "crates/cli", version = "3.3.0", default-features = false }
sp1-core-machine = { path = "crates/core/machine", version = "3.3.0" }
sp1-core-executor = { path = "crates/core/executor", version = "3.3.0" }
sp1-curves = { path = "crates/curves", version = "3.3.0" }
sp1-derive = { path = "crates/derive", version = "3.3.0" }
sp1-eval = { path = "crates/eval", version = "3.3.0" }
sp1-helper = { path = "crates/helper", version = "3.3.0", default-features = false }
sp1-primitives = { path = "crates/primitives", version = "3.3.0" }
sp1-prover = { path = "crates/prover", version = "3.3.0" }
sp1-recursion-compiler = { path = "crates/recursion/compiler", version = "3.3.0" }
sp1-recursion-core = { path = "crates/recursion/core", version = "3.3.0", default-features = false }
sp1-recursion-derive = { path = "crates/recursion/derive", version = "3.3.0", default-features = false }
sp1-recursion-gnark-ffi = { path = "crates/recursion/gnark-ffi", version = "3.3.0", default-features = false }
sp1-recursion-circuit = { path = "crates/recursion/circuit", version = "3.3.0", default-features = false }
sp1-sdk = { path = "crates/sdk", version = "3.3.0" }
sp1-cuda = { path = "crates/cuda", version = "3.3.0" }
sp1-stark = { path = "crates/stark", version = "3.3.0" }
sp1-lib = { path = "crates/zkvm/lib", version = "3.3.0", default-features = false }
sp1-zkvm = { path = "crates/zkvm/entrypoint", version = "3.3.0", default-features = false }
sp1-build = { path = "crates/build", version = "3.4.0" }
sp1-cli = { path = "crates/cli", version = "3.4.0", default-features = false }
sp1-core-machine = { path = "crates/core/machine", version = "3.4.0" }
sp1-core-executor = { path = "crates/core/executor", version = "3.4.0" }
sp1-curves = { path = "crates/curves", version = "3.4.0" }
sp1-derive = { path = "crates/derive", version = "3.4.0" }
sp1-eval = { path = "crates/eval", version = "3.4.0" }
sp1-helper = { path = "crates/helper", version = "3.4.0", default-features = false }
sp1-primitives = { path = "crates/primitives", version = "3.4.0" }
sp1-prover = { path = "crates/prover", version = "3.4.0" }
sp1-recursion-compiler = { path = "crates/recursion/compiler", version = "3.4.0" }
sp1-recursion-core = { path = "crates/recursion/core", version = "3.4.0", default-features = false }
sp1-recursion-derive = { path = "crates/recursion/derive", version = "3.4.0", default-features = false }
sp1-recursion-gnark-ffi = { path = "crates/recursion/gnark-ffi", version = "3.4.0", default-features = false }
sp1-recursion-circuit = { path = "crates/recursion/circuit", version = "3.4.0", default-features = false }
sp1-sdk = { path = "crates/sdk", version = "3.4.0" }
sp1-cuda = { path = "crates/cuda", version = "3.4.0" }
sp1-stark = { path = "crates/stark", version = "3.4.0" }
sp1-lib = { path = "crates/zkvm/lib", version = "3.4.0", default-features = false }
sp1-zkvm = { path = "crates/zkvm/entrypoint", version = "3.4.0", default-features = false }

# p3
p3-air = "0.1.4-succinct"
Expand Down
3 changes: 3 additions & 0 deletions book/writing-programs/patched-crates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ sha3-v0-10-6 = { git = "https://github.com/sp1-patches/RustCrypto-hashes", packa
sha3-v0-10-8 = { git = "https://github.com/sp1-patches/RustCrypto-hashes", package = "sha3", tag = "sha3-v0.10.8-patch-v1" }
crypto-bigint = { git = "https://github.com/sp1-patches/RustCrypto-bigint", tag = "crypto_bigint-v0.5.5-patch-v1" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", tag = "tiny_keccak-v2.0.2-patch-v1" }
# For sp1 versions >= 3.4.0
curve25519-dalek = { git = "https://github.com/sp1-patches/curve25519-dalek", tag = "patch-v4.1.3-v3.4.0" }
# For sp1 versions < 3.4.0
curve25519-dalek = { git = "https://github.com/sp1-patches/curve25519-dalek", tag = "curve25519_dalek-v4.1.3-patch-v1" }
curve25519-dalek-ng = { git = "https://github.com/sp1-patches/curve25519-dalek-ng", tag = "curve25519_dalek_ng-v4.1.1-patch-v1" }
ed25519-consensus = { git = "https://github.com/sp1-patches/ed25519-consensus", tag = "ed25519_consensus-v2.1.0-patch-v1" }
Expand Down
34 changes: 32 additions & 2 deletions crates/core/executor/src/hook.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
/// The file descriptor through which to access `hook_ecrecover_2`.
pub const FD_ECRECOVER_HOOK_2: u32 = 7;

/// The file descriptor through which to access `hook_ed_decompress`.
pub const FD_EDDECOMPRESS: u32 = 8;

/// A runtime hook. May be called during execution by writing to a specified file descriptor,
/// accepting and returning arbitrary data.
pub trait Hook {
Expand Down Expand Up @@ -80,8 +83,9 @@
let table = HashMap::from([
// Note: To ensure any `fd` value is synced with `zkvm/precompiles/src/io.rs`,
// add an assertion to the test `hook_fds_match` below.
(FD_ECRECOVER_HOOK, hookify(hook_ecrecover)),

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Test (ARM) 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Test (ARM) 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Test (x86-64) 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Test (x86-64) 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check failure on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Formatting & Clippy 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Plonk Native 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.

Check warning on line 86 in crates/core/executor/src/hook.rs

View workflow job for this annotation

GitHub Actions / Plonk Docker 

use of deprecated function `hook::hook_ecrecover`: Use `hook_ecrecover_v2` instead.
(FD_ECRECOVER_HOOK_2, hookify(hook_ecrecover_v2)),
(FD_EDDECOMPRESS, hookify(hook_ed_decompress)),
]);

Self { table }
Expand Down Expand Up @@ -179,8 +183,9 @@
sig = sig_normalized;
recovery_id ^= 1;
};
let recid = RecoveryId::from_byte(recovery_id).expect("Computed recovery ID is invalid, this is a bug.");

let recid = RecoveryId::from_byte(recovery_id)
.expect("Computed recovery ID is invalid, this is a bug.");

// Attempting to recvover the public key has failed, write a 0 to indicate to the caller.
let Ok(recovered_key) = VerifyingKey::recover_from_prehash(&msg_hash[..], &sig, recid) else {
return vec![vec![0]];
Expand All @@ -194,6 +199,31 @@
vec![vec![1], bytes.to_vec(), s_inverse.to_bytes().to_vec()]
}

/// Checks if a compressed Edwards point can be decompressed.
///
/// # Arguments
/// * `env` - The environment in which the hook is invoked.
/// * `buf` - The buffer containing the compressed Edwards point.
/// - The compressed Edwards point is 32 bytes.
/// - The high bit of the last byte is the sign bit.
///
/// The result is either `0` if the point cannot be decompressed, or `1` if it can.
///
/// WARNING: This function merely hints at the validity of the compressed point. These values must
/// be constrained by the zkVM for correctness.
#[must_use]
pub fn hook_ed_decompress(_: HookEnv, buf: &[u8]) -> Vec<Vec<u8>> {
let Ok(point) = sp1_curves::curve25519_dalek::CompressedEdwardsY::from_slice(buf) else {
return vec![vec![0]];
};

if sp1_curves::edwards::ed25519::decompress(&point).is_some() {
vec![vec![1]]
} else {
vec![vec![0]]
}
}

#[cfg(test)]
pub mod tests {
use super::*;
Expand Down
Loading
Loading