-
Notifications
You must be signed in to change notification settings - Fork 13k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable Control Flow Guard in rustbuild
- Loading branch information
Showing
5 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
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
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
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
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
34 changes: 34 additions & 0 deletions
34
src/doc/unstable-book/src/compiler-flags/control-flow-guard.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# `control_flow_guard` | ||
|
||
The tracking issue for this feature is: [#68793](https://github.com/rust-lang/rust/issues/68793). | ||
|
||
------------------------ | ||
|
||
The `-Zcontrol_flow_guard=checks` compiler flag enables the Windows [Control Flow Guard][cfguard-docs] platform security feature. When enabled, the compiler outputs a list of valid indirect call targets, and inserts runtime checks on all indirect jump instructions to ensure that the destination is in the list of valid call targets. | ||
|
||
[cfguard-docs]: https://docs.microsoft.com/en-us/windows/win32/secbp/control-flow-guard | ||
|
||
For testing purposes, the `-Zcontrol_flow_guard=nochecks` compiler flag can be used to emit only the list of valid call targets, but not the runtime checks. | ||
|
||
It is strongly recommended to also enable Control Flow Guard checks in all linked libraries, including the standard library. | ||
|
||
To enable Control Flow Guard in the standard library, you can use the [cargo `-Zbuild-std` functionality][build-std] to recompile the standard library with the same configuration options as the main program. | ||
|
||
[build-std]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-std | ||
|
||
For example: | ||
```cmd | ||
rustup toolchain install --force nightly | ||
rustup component add rust-src | ||
SET RUSTFLAGS=-Zcontrol_flow_guard=checks | ||
cargo +nightly build -Z build-std --target x86_64-pc-windows-msvc | ||
``` | ||
|
||
```PowerShell | ||
rustup toolchain install --force nightly | ||
rustup component add rust-src | ||
$Env:RUSTFLAGS = "-Zcontrol_flow_guard=checks" | ||
cargo +nightly build -Z build-std --target x86_64-pc-windows-msvc | ||
``` | ||
|
||
Alternatively, if you are building the standard library from source, you can set `control-flow-guard = true` in the config.toml file. |