os: format readme, fix markdown inside html (#21286)

This commit is contained in:
Turiiya 2024-04-15 13:56:44 +02:00 committed by GitHub
parent 183c199021
commit e676245903
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4,22 +4,20 @@
command line arguments, reading/writing files, listing folders, command line arguments, reading/writing files, listing folders,
handling processes etc. handling processes etc.
* * * ---
### Security advice related to TOCTOU attacks ### Security advice related to TOCTOU attacks
A few `os` module functions can lead to the <b>TOCTOU</b> vulnerability if used incorrectly. A few `os` module functions can lead to the **TOCTOU** vulnerability if used incorrectly.
<b>TOCTOU</b> (Time-of-Check-to-Time-of-Use problem) can occur when a file, folder or similar **TOCTOU** (Time-of-Check-to-Time-of-Use problem) can occur when a file, folder or similar
is checked for certain specifications (e.g. read, write permissions) and a change is made is checked for certain specifications (e.g. read, write permissions) and a change is made
afterwards. afterwards.
In the time between the initial check and the edit, an attacker can then cause damage. In the time between the initial check and the edit, an attacker can then cause damage.
The following example shows an attack strategy on the left and an improved variant on the right The following example shows an attack strategy on the left and an improved variant on the right
so that <b>TOCTOU</b> is no longer possible. so that **TOCTOU** is no longer possible.
**Example** <br>
<b>Example</b> *Hint*: `os.create()` opens a file in write-only mode
<i>Hint</i>: `os.create()` opens a file in write-only mode
<table> <table>
<tr> <tr>
@ -39,6 +37,7 @@ if os.is_writable("file") {
f.close() f.close()
} }
``` ```
</td> </td>
<td> <td>
@ -52,14 +51,15 @@ mut f := os.create('path/to/file') or {
f.close() f.close()
``` ```
</td> </td>
</tr> </tr>
</table> </table>
<b> Proven affected functions </b></br> **Proven affected functions** <br>
The following functions should be used with care and only when used correctly. The following functions should be used with care and only when used correctly.
* os.is_readable() - os.is_readable()
* os.is_writable() - os.is_writable()
* os.is_executable() - os.is_executable()
* os.is_link() - os.is_link()