Add documentation regarding security issues and the status of Wasm proposals #3972
+107
−0
Conversation
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
lum1n0us
requested review from
loganek,
no1wudi,
wenyongh,
xujuntwt95329 and
yamt
as code owners
wenyongh
reviewed
Dec 20, 2024
yamt
reviewed
Dec 20, 2024
doc/stability_wasm_proposals.md
Outdated
| | Extended Constant Expressions | Yes | N/A | | ||
| | Typed Function References | Yes | `WAMR_BUILD_GC` | | ||
| | Thread | Yes | `WAMR_BUILD_SHARED_MEMORY` | | ||
| | Exception handling[^2] | Yes | `WAMR_BUILD_EXCE_HANDLING` | |
There was a problem hiding this comment.
this is misleading because what we have is not the phase 4 version.
There was a problem hiding this comment.
Yes. I will move this one to unimplemented Wasm proposals
| @@ -0,0 +1,28 @@ | |||
| # About security issues | |||
|
|
|||
| This document aims to explain the process of identifying a security issue and the steps for managing a security issue. | |||
There was a problem hiding this comment.
the expected audiences and purposes of this document are not obvious to me.
There was a problem hiding this comment.
The document is intended to:
- Clarify to the community and TSC which types of issues will be recognized as security issues.
- Provide a step-by-step guide on how to handle a security issue once it has been identified.
- Ensure maintainers distinguish security issues from all reported community issues and address them with caution.
- Encourage accurate reporting of security issues, rather than categorizing them as normal issues.
doc/stability_wasm_proposals.md
Outdated
| | Legacy Exception handling[^2] | Yes | `WAMR_BUILD_EXCE_HANDLING` | | ||
| | WebAssembly C and C++ API | No | N/A | | ||
|
|
||
| [^1]: jit and aot only |
There was a problem hiding this comment.
Do we need to classify fast-jit and LLVM-jit?
…t" in the legacy exception handling note
doc/security_need_to_know.md
Outdated
|
|
||
| Before reporting an issue, particularly one related to crashing, consult [the cheat sheet](https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md#cheat-sheet-is-this-bug-considered-a-security-vulnerability), _Report a security vulnerability_ if it qualifies. | ||
|
|
||
| Upon receiving an issue, thoroughly review [the cheat sheet](https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md#cheat-sheet-is-this-bug-considered-a-security-vulnerability) to assess and _Report a security vulnerability_ if the issue is indeed a security vulnerability . |
There was a problem hiding this comment.
Suggested change
| Upon receiving an issue, thoroughly review [the cheat sheet](https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md#cheat-sheet-is-this-bug-considered-a-security-vulnerability) to assess and _Report a security vulnerability_ if the issue is indeed a security vulnerability . | |
| Upon receiving an issue, thoroughly review [the cheat sheet](https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md#cheat-sheet-is-this-bug-considered-a-security-vulnerability) to assess and _Report a security vulnerability_ if the issue is indeed a security vulnerability. |
doc/security_need_to_know.md
Outdated
| - Enables users to perform actions they should not be able to. | ||
| - Allows users to deny actions they have performed. | ||
|
|
||
| Given that WASI is a set of Capability-based APIs, all unauthorized actions are not supposed to happen. Most of the above security concerns can be alleviated. What remains for us is to ensure that Wasm modules' execution is secure. In other words, do not compromise the sandbox. Unless it is explicitly disabled beforehand. |
There was a problem hiding this comment.
Maybe it can be rephrased as "What remains for us is to ensure that the execution of Wasm modules is secure."
doc/stability_wasm_proposals.md
Outdated
| | Bulk memory operations | Yes | `WAMR_BUILD_BULK_MEMORY` | | ||
| | Fixed-width SIMD[^1] | Yes | `WAMR_BUILD_SIMD` | | ||
| | Extended Constant Expressions | Yes | N/A | | ||
| | Typed Function References | Yes | `WAMR_BUILD_GC` | |
There was a problem hiding this comment.
Maybe type function references should be in off-by-default? Since it needs to enable GC first
doc/stability_wasm_proposals.md
Outdated
| | Tail call | Yes | `WAMR_BUILD_TAIL_CALL` | | ||
| | Garbage collection | Yes | `WAMR_BUILD_GC` | | ||
| | Multiple memories[^3] | Yes | `WAMR_BUILD_MULTI_MEMORY` | | ||
| | Memory64 | Yes | `WAMR_BUILD_MEMORY64` | |
There was a problem hiding this comment.
WAMR also have WAMR_BUILD_STRINGREF for Reference-Typed Strings, although it's only phase 1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.