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

STR-782: add a warning about partial MuSig2 verification #558

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AaronFeickert
Copy link
Contributor

Description

This PR updates the documentation for partial MuSig2 signature verification to caution against assuming unforgeability of partial signatures.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor
  • New or updated tests
  • Dependency Update

Notes to Reviewers

Checklist

  • I have performed a self-review of my code.
  • I have commented my code where necessary.
  • I have updated the documentation if needed.
  • My changes do not introduce new warnings.
  • I have added tests that prove my changes are effective or that my feature works.
  • New and existing tests pass with my changes.

Related Issues

@AaronFeickert AaronFeickert requested a review from a team as a code owner December 23, 2024 18:14
@AaronFeickert AaronFeickert force-pushed the partial-verification-docs branch from e29df74 to f9155e2 Compare December 23, 2024 18:18
Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.31%. Comparing base (506fd5c) to head (f9155e2).

@@            Coverage Diff             @@
##             main     #558      +/-   ##
==========================================
- Coverage   57.33%   57.31%   -0.03%     
==========================================
  Files         309      309              
  Lines       31510    31510              
==========================================
- Hits        18067    18059       -8     
- Misses      13443    13451       +8     
Files with missing lines Coverage Δ
crates/bridge-sig-manager/src/operations.rs 96.70% <ø> (ø)

... and 5 files with indirect coverage changes

@@ -113,6 +113,14 @@ pub fn sign_state_partial(
}

/// Verify that a partial MuSig2 signature is correct.
///
/// WARNING: It is possible for an adverary to forge a partial signature under certain conditions.
Copy link
Contributor

@Rajil1213 Rajil1213 Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you link to any relevant resources for what these conditions are? This is both for this documentation and for myself. 😅

PS: there's also a typo in adversary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants