-
-
Notifications
You must be signed in to change notification settings - Fork 128
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
Updated Security Section #242
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d4f8f75
Created AUDITS.md, included details from Cantina Finding
CanonicalJP f0f2d98
Update AUDITS.md, added Certora's detail
CanonicalJP 1f6553d
Updated AUDITS.md
CanonicalJP 5094ba6
Updated AUDITS.md
CanonicalJP 0ef616b
Updated README.md
CanonicalJP 1e0240f
Updated AUDITS.md
CanonicalJP File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Security Review History for PRBMath | ||
|
||
| :warning: | Audits are not a guarantee of correctness. Some parts of the code base were modified after they were audited. | | ||
| --------- | :------------------------------------------------------------------------------------------------------------ | | ||
|
||
The PRBMath library was included in the Sablier codebase audited by the [Cantina](https://cantina.xyz/welcome) team during May-June of 2023. Likewise, the [Certora](https://medium.com/certora/problems-in-solidity-fixed-point-libraries-certora-bug-disclosure-987f504daca4) team identified a design flaw in April of 2023. Both issues were timely addressed and are now fixed. | ||
|
||
| Auditor | Type | Initial Commit | Report | | ||
| :---------------- | :------ | :------------------- | :--------------------------------------------- | | ||
| Cantina | Firm | [prb-math@v3.3.3](https://github.com/PaulRBerg/prb-math/tree/v3.3.2) | [2023-06-08](https://github.com/sablier-labs/audits/blob/6567df3fa42b90663e3e694b1e776c6db337a3f2/v2-core/cantina-2023-06-08.pdf) | | ||
| Certora | Firm | [prb-math@v4.0.0](https://github.com/PaulRBerg/prb-math/tree/v4.0.0) | [2023-07-12](https://medium.com/certora/problems-in-solidity-fixed-point-libraries-certora-bug-disclosure-987f504daca4) | | ||
|
||
## Cantina Review | ||
|
||
In May-June of 2023, the team realized a security review of `Sablier v1.0.0`, which included `prb-math@v3.3.3` in the scope. The report of the review included a finding for the PRBMath library: "3.2.3 PRBMath pow() function can return inconsistent values." | ||
|
||
### Issue: PRBMath pow() function can return inconsistent values | ||
|
||
- _Full report_: [cantina-2023-06-08.pdf](https://github.com/sablier-labs/audits/blob/6567df3fa42b90663e3e694b1e776c6db337a3f2/v2-core/cantina-2023-06-08.pdf) | ||
- _PRBMath version_: [prb-math@v3.3.3](https://github.com/PaulRBerg/prb-math/tree/v3.3.2) | ||
- _Severity_: High Risk | ||
- _Context_: [sd59x18/Math.sol#L596-L609](https://github.com/PaulRBerg/prb-math/blob/df27d3d12ce12153fb166e1e310c8351210dc7ba/src/sd59x18/Math.sol#L596-L609) | ||
- _Status_: `Fixed` in https://github.com/PaulRBerg/prb-math/pull/179, which was included in release https://github.com/PaulRBerg/prb-math/releases/tag/v4.0.0 | ||
|
||
## Certora Review | ||
|
||
In April of 2023, the team reported a security bug in `prb-math@v4.0.0`, the discussion of which was tracked in https://github.com/PaulRBerg/prb-math/discussions/186 | ||
|
||
### Issue: Wrong rounding direction for negative numbers | ||
|
||
- _Full Analysis_: [Problems in Solidity Fixed Point Libraries — Certora Bug Disclosure](https://medium.com/certora/problems-in-solidity-fixed-point-libraries-certora-bug-disclosure-987f504daca4) | ||
- _PRBMath version_: [prb-math@v4.0.0](https://github.com/PaulRBerg/prb-math/tree/v4.0.0) | ||
- _Severity_: Not clear, potentially Critical/High | ||
- _Context_: [src/Common.sol#L387](https://github.com/PaulRBerg/prb-math/blob/7ce3009bbfa0d8e2d430b7a1a9ca46b6e706d90d/src/Common.sol#L387) | ||
- _Status_: `Mitigated` with "Clarify rounding modes" in release https://github.com/PaulRBerg/prb-math/releases/tag/v4.0.1 | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The standard place to place security-related information is the
SECURITY.md
file. Let's move this file over there.