Skip to content

Commit 1af0073

Browse files
lum1n0uslum1n0us
committed
Enhance security guidelines for identifying vulnerabilities
1 parent 42851ca commit 1af0073

2 files changed

Lines changed: 134 additions & 3 deletions

File tree

‎doc/security_need_to_know.md‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,31 @@ It is commonly stated that a security issue is an issue that:
1515

1616
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

18-
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).
18+
### Is this bug considered a security vulnerability?
1919

20-
> [!NOTE]
21-
> keep updating this document as the project evolves.
20+
For someone who finds a problem, if a bug causes the program to stop working, please treat it as a security problem and report it to a security advisor. The person in charge will look into it and change its category if needed.
21+
22+
For those in charge, please use the following guidelines to determine if a bug or advisory is a security issue:
23+
24+
Only bugs that affect tier A platforms or features should be considered.
25+
26+
Anything that works immediately without setup is a security issue. However, actions that differ from Wasm rules (like calculating wrong values) are not seen as security issues as long as they stay within the sandbox.
27+
28+
(TBD) Systems that use embedded code trust values from the guest. Those who call functions should ensure they provide correct parameters.
29+
30+
(TBD) .wasm files are not trusted, but .aot files are trusted.
31+
32+
A denial-of-service (DoS) attack is a cyberattack that aims to make a computer or network resource unavailable to its users. If the service (runtime in this case) can recover and start another module or run another function within the same instance, it is not considered unavailable, and thus not a Denial of Service (DoS). However, to ensure safety, avoiding risky execution can help prevent similar difficult situations (like unwanted imported functions).
33+
34+
### When you identify a problem that should be classified as a security vulnerability
35+
36+
Act quickly and reduce exposure. Once you realize the issue or pull request describes a real or possible security vulnerability, handle it as sensitive information. Do not share technical details publicly on the issue or pull request.
37+
38+
Close or edit the public discussion. Thank the person who reported it and explain that issues related to security should go through the Security Advisory process. Close the public issue or pull request as soon as possible to stop further public sharing. If details are already shared, think about editing or asking GitHub staff to remove sensitive content.
39+
40+
Direct the reporter to the right channel. Set up a Security Advisory for the project and invite the reporter to join as a collaborator. If the reporter is not comfortable using GitHub Security Advisories, offer another secure way to communicate (like encrypted email).
41+
42+
Follow the guidelines in [the security issue runbook](./security_issue_runbook.md) for the next steps.
2243

2344
## reporting a security issue
2445

‎doc/tired_support.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
## Tired Supported
2+
3+
- A. Production Ready. full tested. the highest level of support, confidence, and correctness for a component.
4+
- B. Almost Production Ready. partially tested.
5+
- C. Not Production Ready. experimental or not finished.
6+
7+
> [!TODO]
8+
> ⬇️
9+
10+
| Target | Tired |
11+
| ------ | ----- |
12+
| X86 | A |
13+
| X86-64 | A |
14+
15+
| Platform | Tired |
16+
| -------- | ----- |
17+
| Ubuntu | A |
18+
19+
## All compilation flags
20+
21+
| Compilation flags | Tired | Default | on Ubuntu |
22+
| ------------------------------------------- | ----- | ------- | --------- |
23+
| WAMR_APP_THREAD_STACK_SIZE_MAX | B | ND[^1] | |
24+
| WAMR_BH_LOG | B | ND | |
25+
| WAMR_BH_VPRINTF | B | ND | |
26+
| WAMR_BUILD_ALLOC_WITH_USAGE | B | ND | |
27+
| WAMR_BUILD_ALLOC_WITH_USER_DATA | B | ND | |
28+
| WAMR_BUILD_AOT | A | ND | 1 |
29+
| WAMR_BUILD_AOT_INTRINSICS | A | 1[^2] | |
30+
| WAMR_BUILD_AOT_STACK_FRAME | A | ND | |
31+
| WAMR_BUILD_AOT_VALIDATOR | B | ND | |
32+
| WAMR_BUILD_BULK_MEMORY | A | 1 | |
33+
| WAMR_BUILD_COPY_CALL_STACK | B | ND | |
34+
| WAMR_BUILD_CUSTOM_NAME_SECTION | B | ND | |
35+
| WAMR_BUILD_DEBUG_AOT | B | ND | |
36+
| WAMR_BUILD_DEBUG_INTERP | B | ND | |
37+
| WAMR_BUILD_DUMP_CALL_STACK | A | ND | |
38+
| WAMR_BUILD_DYNAMIC_AOT_DEBUG | B | ND | |
39+
| WAMR_BUILD_EXCE_HANDLING | B | 0 | |
40+
| WAMR_BUILD_EXTENDED_CONST_EXPR | A | 0 | |
41+
| WAMR_BUILD_FAST_INTERP | A | ND | 1 |
42+
| WAMR_BUILD_FAST_JIT | B | ND | |
43+
| WAMR_BUILD_FAST_JIT_DUMP | B | ND | |
44+
| WAMR_BUILD_GC | B | 0 | |
45+
| WAMR_BUILD_GC_HEAP_VERIFY | B | ND | |
46+
| WAMR_BUILD_GLOBAL_HEAP_POOL | A | ND | |
47+
| WAMR_BUILD_GLOBAL_HEAP_SIZE | A | ND | |
48+
| WAMR_BUILD_INSTRUCTION_METERING | C | ND | |
49+
| WAMR_BUILD_INTERP | A | ND | 1 |
50+
| WAMR_BUILD_INVOKE_NATIVE_GENERAL | B | ND | |
51+
| WAMR_BUILD_JIT | B | ND | |
52+
| WAMR_BUILD_LAZY_JIT | B | 1[^3] | |
53+
| WAMR_BUILD_LIBC_BUILTIN | A | ND | 1 |
54+
| WAMR_BUILD_LIBC_EMCC | C | ND | |
55+
| WAMR_BUILD_LIBC_UVWASI | B | ND | |
56+
| WAMR_BUILD_LIBC_WASI | A | ND | 1 |
57+
| WAMR_BUILD_LIB_PTHREAD | A | ND | |
58+
| WAMR_BUILD_LIB_PTHREAD_SEMAPHORE | A | ND | |
59+
| WAMR_BUILD_LIB_RATS | B | ND | |
60+
| WAMR_BUILD_LIB_WASI_THREADS | A | ND | |
61+
| WAMR_BUILD_LINUX_PERF | B | ND | |
62+
| WAMR_BUILD_LOAD_CUSTOM_SECTION | A | ND | |
63+
| WAMR_BUILD_MEMORY64 | A | 0 | |
64+
| WAMR_BUILD_MEMORY_PROFILING | A | ND | |
65+
| WAMR_BUILD_MINI_LOADER | B | ND | |
66+
| WAMR_BUILD_MODULE_INST_CONTEXT | B | ND | 1 |
67+
| WAMR_BUILD_MULTI_MEMORY | A | 0 | |
68+
| WAMR_BUILD_MULTI_MODULE | B | ND | |
69+
| WAMR_BUILD_PERF_PROFILING | A | ND | |
70+
| WAMR_BUILD_PLATFORM | | ND | linux |
71+
| WAMR_BUILD_QUICK_AOT_ENTRY | A | 1[^4] | |
72+
| WAMR_BUILD_REF_TYPES | A | ND | 1 |
73+
| WAMR_BUILD_SANITIZER | B | ND | |
74+
| WAMR_BUILD_SGX_IPFS | B | ND | |
75+
| WAMR_BUILD_SHARED_HEAP | A | ND | |
76+
| WAMR_BUILD_SHARED_MEMORY | A | 0 | 1 |
77+
| WAMR_BUILD_SHRUNK_MEMORY | A | ND | 1 |
78+
| WAMR_BUILD_SIMD | A | ND | 1 |
79+
| WAMR_BUILD_SIMDE | B | ND | 1 |
80+
| WAMR_BUILD_SPEC_TEST | A | ND | |
81+
| WAMR_BUILD_STACK_GUARD_SIZE | A | ND | |
82+
| WAMR_BUILD_STATIC_PGO | B | ND | |
83+
| WAMR_BUILD_STRINGREF | B | 0 | |
84+
| WAMR_BUILD_TAIL_CALL | A | 0 | 1 |
85+
| WAMR_BUILD_TARGET | | ND | X86-64 |
86+
| WAMR_BUILD_THREAD_MGR | A | ND | |
87+
| WAMR_BUILD_WAMR_COMPILER | A | ND | |
88+
| WAMR_BUILD_WASI_EPHEMERAL_NN | B | ND | |
89+
| WAMR_BUILD_WASI_NN | B | ND | |
90+
| WAMR_BUILD_WASI_NN_ENABLE_EXTERNAL_DELEGATE | B | ND | |
91+
| WAMR_BUILD_WASI_NN_ENABLE_GPU | B | ND | |
92+
| WAMR_BUILD_WASI_NN_EXTERNAL_DELEGATE_PATH | B | ND | |
93+
| WAMR_BUILD_WASI_NN_LLAMACPP | B | ND | |
94+
| WAMR_BUILD_WASI_NN_ONNX | B | ND | |
95+
| WAMR_BUILD_WASI_NN_OPENVINO | B | ND | |
96+
| WAMR_BUILD_WASI_NN_TFLITE | B | ND | |
97+
| WAMR_BUILD_WASI_TEST | B | ND | |
98+
| WAMR_BUILD_WASM_CACHE | B | ND | |
99+
| WAMR_CONFIGURABLE_BOUNDS_CHECKS | C | ND | |
100+
| WAMR_DISABLE_APP_ENTRY | A | ND | |
101+
| WAMR_DISABLE_HW_BOUND_CHECK | A | ND | |
102+
| WAMR_DISABLE_STACK_HW_BOUND_CHECK | A | ND | |
103+
| WAMR_DISABLE_WAKEUP_BLOCKING_OP | B | ND | |
104+
| WAMR_DISABLE_WRITE_GS_BASE | B | ND | |
105+
| WAMR_TEST_GC | B | ND | |
106+
107+
[^1]: _ND_ represents _not defined_
108+
[^2]: active if `WAMR_BUILD_AOT` is 1
109+
[^3]: active if `WAMR_BUILD_FAST_JIT` or `WARM_BUILD_JIT1` is 1
110+
[^4]: active if `WAMR_BUILD_AOT` or `WAMR_BUILD_JIT` is 1

0 commit comments

Comments
 (0)