Skip to content

Commit

Permalink
docs: update readme with vuln notes
Browse files Browse the repository at this point in the history
  • Loading branch information
colinnielsen committed Nov 27, 2024
1 parent 056eace commit 8b49612
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@

**This software is unaudited and should not be used in production. Use at your own risk.**

## WARNING!

**DO NOT use versions of this library < `v0.30.0`**

This library contained a critical vulnerability found by @olehmisar. The circuits were critically underconstrained, allowing anyone to impersonate public Ethereum addresses.

See more details [here](https://gist.github.com/olehmisar/4cfe6128eaac2bfbe1fa8eb46f0116d6).

<hr>

**ECRecover Noir** includes tools to help prove secp256k1 signatures (Ethereum's curve) in Noir Circuits.
Expand All @@ -21,7 +29,7 @@ In your `Nargo.toml` file, add the following dependency:

```toml
[dependencies]
ecrecover = { tag = "v0.19.0", git = "https://github.com/colinnielsen/ecrecover-noir" }
ecrecover = { tag = "v0.30.0", git = "https://github.com/colinnielsen/ecrecover-noir" }
```

## Simple Usage
Expand Down

0 comments on commit 8b49612

Please sign in to comment.