Skip to content

Commit 9af3de2

Browse files
committed
Refine security documentation and reorganize Wasm proposals for clarity
1 parent 5d3ae57 commit 9af3de2

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

doc/security_need_to_know.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It is commonly stated that a security issue is an issue that:
1313
- Enables users to perform actions they should not be able to.
1414
- Allows users to deny actions they have performed.
1515

16-
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.
16+
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 the execution of Wasm modules is secure. In other words, do not compromise the sandbox. Unless it is explicitly disabled beforehand.
1717

1818
Thus, we share most of the criteria for judging security issues with [the Bytecode Alliance](https://github.com/bytecodealliance/rfcs/blob/main/accepted/what-is-considered-a-security-bug.md#definition).
1919

@@ -28,6 +28,6 @@ Follow the [same guidelines](https://bytecodealliance.org/security) as other pro
2828

2929
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.
3030

31-
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 .
31+
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.
3232

3333
Once a security issue is confirmed, please refer to [the runbook](https://github.com/bytecodealliance/rfcs/blob/main/accepted/vulnerability-response-runbook.md) for the subsequent steps to take.

doc/stability_wasm_proposals.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,42 +14,43 @@ Users can turn those features on or off by using compilation options. If a relev
1414

1515
| Proposal | Phase 4 | Compilation Option |
1616
| ------------------------------------- | ------- | -------------------------- |
17-
| Non-trapping float-to-int conversions | Yes | N/A |
18-
| Sign-extension operators | Yes | N/A |
19-
| Multi-value | Yes | N/A |
20-
| Reference Types | Yes | `WAMR_BUILD_REF_TYPES` |
2117
| Bulk memory operations | Yes | `WAMR_BUILD_BULK_MEMORY` |
22-
| Fixed-width SIMD[^1] | Yes | `WAMR_BUILD_SIMD` |
2318
| Extended Constant Expressions | Yes | N/A |
24-
| Typed Function References | Yes | `WAMR_BUILD_GC` |
25-
| Thread | Yes | `WAMR_BUILD_SHARED_MEMORY` |
19+
| Fixed-width SIMD[^1] | Yes | `WAMR_BUILD_SIMD` |
2620
| Legacy Exception handling[^2] | Yes | `WAMR_BUILD_EXCE_HANDLING` |
21+
| Multi-value | Yes | N/A |
22+
| Non-trapping float-to-int conversions | Yes | N/A |
23+
| Reference Types | Yes | `WAMR_BUILD_REF_TYPES` |
24+
| Sign-extension operators | Yes | N/A |
25+
| Thread | Yes | `WAMR_BUILD_SHARED_MEMORY` |
2726
| WebAssembly C and C++ API | No | N/A |
2827

2928
[^1]: llvm-jit and aot only
3029
[^2]: interpreter only
3130

3231
## Off-by-default Wasm Proposals
3332

34-
| Proposal | Phase 4 | Compilation Option |
35-
| --------------------- | ------- | ------------------------- |
36-
| Tail call | Yes | `WAMR_BUILD_TAIL_CALL` |
37-
| Garbage collection | Yes | `WAMR_BUILD_GC` |
38-
| Multiple memories[^3] | Yes | `WAMR_BUILD_MULTI_MEMORY` |
39-
| Memory64 | Yes | `WAMR_BUILD_MEMORY64` |
33+
| Proposal | Phase 4 | Compilation Option |
34+
| ------------------------- | ------- | ------------------------- |
35+
| Garbage collection | Yes | `WAMR_BUILD_GC` |
36+
| Memory64 | Yes | `WAMR_BUILD_MEMORY64` |
37+
| Multiple memories[^3] | Yes | `WAMR_BUILD_MULTI_MEMORY` |
38+
| Reference-Typed Strings | No | `WAMR_BUILD_STRINGREF` |
39+
| Tail call | Yes | `WAMR_BUILD_TAIL_CALL` |
40+
| Typed Function References | Yes | `WAMR_BUILD_GC` |
4041

4142
[^3]: interpreter only
4243

4344
## Unimplemented Wasm Proposals
4445

4546
| Proposal | Phase 4 |
4647
| ------------------------------------------- | ------- |
47-
| Import/Export of Mutable Globals | Yes |
48-
| Relaxed SIMD | Yes |
49-
| Custom Annotation Syntax in the Text Format | Yes |
5048
| Branch Hinting | Yes |
51-
| JS String Builtins | Yes |
49+
| Custom Annotation Syntax in the Text Format | Yes |
5250
| Exception handling | Yes |
51+
| Import/Export of Mutable Globals | Yes |
52+
| JS String Builtins | Yes |
53+
| Relaxed SIMD | Yes |
5354

5455
## On-by-default WASI Proposals
5556

0 commit comments

Comments
 (0)