Skip to content

Commit 7d3bb23

Browse files
committed
Improve security documentation and clarify Wasm proposal statuses
1 parent ee647ab commit 7d3bb23

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

doc/security_need_to_know.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,29 @@ This document aims to explain the process of identifying a security issue and th
55
## identifying a security issue
66

77
It is commonly stated that a security issue is an issue that:
8+
89
- Exposes sensitive information to unauthorized parties.
910
- Allows unauthorized modification of data or system state.
1011
- Affects the availability of the system or its services.
1112
- Permits unauthorized access to the system.
1213
- Enables users to perform actions they should not be able to.
1314
- Allows users to deny actions they have performed.
1415

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

1718
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).
1819

19-
>[!NOTE]
20+
> [!NOTE]
2021
> keep updating this document as the project evolves.
2122
23+
## reporting a security issue
24+
25+
Follow the [same guidelines](https://bytecodealliance.org/security) as other projects within the Bytecode Alliance.
26+
2227
## managing a security issue
2328

24-
Before reporting an issue, particularly one related to crashing, consult [the cheat sheet](), *Report a security vulnerability* if it qualifies.
29+
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.
2530

26-
Upon receiving an issue, thoroughly review [the cheat sheet] 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 .
2732

2833
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: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Normally, the document tracks proposals that are in phase 4. However, if a propo
88

99
The _status_ represents the configuration _product-mini/platforms/linux/CMakeLists.txt_. There may be minor differences between the top-level CMakeLists and platform-specific CMakeLists.
1010

11-
Users can turn those features on or off using compilation options. If a relevant compilation option is not available(`N/A`), it indicates that the feature is permanently enabled.
11+
Users can turn those features on or off by using compilation options. If a relevant compilation option is not available(`N/A`), it indicates that the feature is permanently enabled.
1212

1313
## On-by-default Wasm Proposals
1414

@@ -23,7 +23,7 @@ Users can turn those features on or off using compilation options. If a relevant
2323
| Extended Constant Expressions | Yes | N/A |
2424
| Typed Function References | Yes | `WAMR_BUILD_GC` |
2525
| Thread | Yes | `WAMR_BUILD_SHARED_MEMORY` |
26-
| Exception handling[^2] | Yes | `WAMR_BUILD_EXCE_HANDLING` |
26+
| Legacy Exception handling[^2] | Yes | `WAMR_BUILD_EXCE_HANDLING` |
2727
| WebAssembly C and C++ API | No | N/A |
2828

2929
[^1]: jit and aot only
@@ -49,6 +49,7 @@ Users can turn those features on or off using compilation options. If a relevant
4949
| Custom Annotation Syntax in the Text Format | Yes |
5050
| Branch Hinting | Yes |
5151
| JS String Builtins | Yes |
52+
| Exception handling | Yes |
5253

5354
## On-by-default WASI Proposals
5455

@@ -69,4 +70,4 @@ Users can turn those features on or off using compilation options. If a relevant
6970

7071
## WAMR features
7172

72-
WAMR offers a variety of customizable features to create a highly efficient runtime. For more details, please refer to [build_wamr](./build_wamr.md).
73+
WAMR offers a variety of customizable features to create a highly efficient runtime. For more details, please refer to [build_wamr](./build_wamr.md).

0 commit comments

Comments
 (0)