Impact
Under certain concurrent event orderings, a wasmtime::Engine
's internal type registry was susceptible to double-unregistration bugs due to a race condition, leading to panics and potentially type registry corruption. That registry corruption could, following an additional and particular sequence of concurrent events, lead to violations of WebAssembly's control-flow integrity (CFI) and type safety. Users that do not use wasmtime::Engine
across multiple threads are not affected. Users that only create new modules across threads over time are additionally not affected.
Reproducing this bug requires creating and dropping multiple type instances (such as wasmtime::FuncType
or wasmtime::ArrayType
) concurrently on multiple threads, where all types are associated with the same wasmtime::Engine
. Wasm guests cannot trigger this bug. See the "References" section below for a list of Wasmtime types-related APIs that are affected.
Wasmtime maintains an internal registry of types within a wasmtime::Engine
and an engine is shareable across threads. Types can be created and referenced through creation of a wasmtime::Module
, creation of wasmtime::FuncType
, or a number of other APIs where the host creates a function (see "References" below). Each of these cases interacts with an engine to deduplicate type information and manage type indices that are used to implement type checks in WebAssembly's call_indirect
function, for example. This bug is a race condition in this management where the internal type registry could be corrupted to trigger an assert or contain invalid state.
Wasmtime's internal representation of a type has individual types (e.g. one-per-host-function) maintain a registration count of how many time it's been used. Types additionally have state within an engine behind a read-write lock such as lookup/deduplication information. The race here is a time-of-check versus time-of-use (TOCTOU) bug where one thread atomically decrements a type entry's registration count, observes zero registrations, and then acquires a lock in order to unregister that entry. However, between when this first thread observed the zero-registration count and when it acquires that lock, another thread could perform the following sequence of events: re-register another copy of the type, which deduplicates to that same entry, resurrecting it and incrementing its registration count; then drop the type and decrement its registration count; observe that the registration count is now zero; acquire the type registry lock; and finally unregister the type. Now, when the original thread finally acquires the lock and unregisters the entry, it is the second time this entry has been unregistered.
Thread A |
Thread B |
acquire(type registry lock) |
|
|
decref(E) --> 0 |
|
block_on(type registry lock) |
register(E') == incref(E) --> 1 |
|
release(type registry lock) |
|
decref(E) --> 0 |
|
acquire(type registry lock) |
|
unregister(E) |
|
release(type registry lock) |
|
|
acquire(type registry lock) |
|
unregister(E) |
This double-unregistration could then lead to a WebAssembly CFI violation under the following conditions: a new WebAssembly module X
was loaded into the engine before the second, buggy unregistration occurs; X
defined a function type F
that was allocated in the same type registry slot where the original entry was allocated; the second, buggy unregistration incorrectly unregistered F
; another new WebAssembly module Y
was loaded into the engine; Y
defined a function type G
, different from F
, but which is also allocated in the same type registry slot; a funcref
of type G
is created, either by the host or by Wasm; that funcref
is passed to a WebAssembly instance of module X
; that instance performs a call_indirect
to that funcref
; the call_indirect
's dynamic type check, which preserves CFI, could incorrectly pass in this case, because F
and G
were assigned the same type registry slot. This would, ultimately, allow calling a function with too many, too few, or wrongly-typed arguments, violating CFI and type safety.
We were not able to reproduce this CFI violation in a vanilla Wasmtime build, although it remains theoretically possible. However, by modifying Wasmtime's source code to make losing the races described above more likely (by disabling certain assertions, inserting panic catches, and adding retry loops in a few places if we did not lose the race) we were able to incorrectly get a funcref
to pass a type check that it should have failed, which would allow the CFI violation.
Patches
This bug was originally introduced in Wasmtime 19's development of the WebAssembly GC proposal. This bug affects users who are not using the GC proposal, however, and affects Wasmtime in its default configuration even when the GC proposal is disabled. Wasmtime users using 19.0.0 and after are all affected by this issue. We have released the following Wasmtime versions, all of which have a fix for this bug:
- 21.0.2
- 22.0.1
- 23.0.3
- 24.0.1
- 25.0.2
Workarounds
If your application creates and drops Wasmtime types on multiple threads concurrently, there are no known workarounds. Users are encouraged to upgrade to a patched release.
References
The following APIs create or drop types, and therefore are affected by this race condition if performed on multiple threads concurrently and are all associated with the same wasmtime::Engine
:
The change which introduced this bug was #7969
References
Impact
Under certain concurrent event orderings, a
wasmtime::Engine
's internal type registry was susceptible to double-unregistration bugs due to a race condition, leading to panics and potentially type registry corruption. That registry corruption could, following an additional and particular sequence of concurrent events, lead to violations of WebAssembly's control-flow integrity (CFI) and type safety. Users that do not usewasmtime::Engine
across multiple threads are not affected. Users that only create new modules across threads over time are additionally not affected.Reproducing this bug requires creating and dropping multiple type instances (such as
wasmtime::FuncType
orwasmtime::ArrayType
) concurrently on multiple threads, where all types are associated with the samewasmtime::Engine
. Wasm guests cannot trigger this bug. See the "References" section below for a list of Wasmtime types-related APIs that are affected.Wasmtime maintains an internal registry of types within a
wasmtime::Engine
and an engine is shareable across threads. Types can be created and referenced through creation of awasmtime::Module
, creation ofwasmtime::FuncType
, or a number of other APIs where the host creates a function (see "References" below). Each of these cases interacts with an engine to deduplicate type information and manage type indices that are used to implement type checks in WebAssembly'scall_indirect
function, for example. This bug is a race condition in this management where the internal type registry could be corrupted to trigger an assert or contain invalid state.Wasmtime's internal representation of a type has individual types (e.g. one-per-host-function) maintain a registration count of how many time it's been used. Types additionally have state within an engine behind a read-write lock such as lookup/deduplication information. The race here is a time-of-check versus time-of-use (TOCTOU) bug where one thread atomically decrements a type entry's registration count, observes zero registrations, and then acquires a lock in order to unregister that entry. However, between when this first thread observed the zero-registration count and when it acquires that lock, another thread could perform the following sequence of events: re-register another copy of the type, which deduplicates to that same entry, resurrecting it and incrementing its registration count; then drop the type and decrement its registration count; observe that the registration count is now zero; acquire the type registry lock; and finally unregister the type. Now, when the original thread finally acquires the lock and unregisters the entry, it is the second time this entry has been unregistered.
acquire(type registry lock)
decref(E) --> 0
block_on(type registry lock)
register(E') == incref(E) --> 1
release(type registry lock)
decref(E) --> 0
acquire(type registry lock)
unregister(E)
release(type registry lock)
acquire(type registry lock)
unregister(E)
This double-unregistration could then lead to a WebAssembly CFI violation under the following conditions: a new WebAssembly module
X
was loaded into the engine before the second, buggy unregistration occurs;X
defined a function typeF
that was allocated in the same type registry slot where the original entry was allocated; the second, buggy unregistration incorrectly unregisteredF
; another new WebAssembly moduleY
was loaded into the engine;Y
defined a function typeG
, different fromF
, but which is also allocated in the same type registry slot; afuncref
of typeG
is created, either by the host or by Wasm; thatfuncref
is passed to a WebAssembly instance of moduleX
; that instance performs acall_indirect
to thatfuncref
; thecall_indirect
's dynamic type check, which preserves CFI, could incorrectly pass in this case, becauseF
andG
were assigned the same type registry slot. This would, ultimately, allow calling a function with too many, too few, or wrongly-typed arguments, violating CFI and type safety.We were not able to reproduce this CFI violation in a vanilla Wasmtime build, although it remains theoretically possible. However, by modifying Wasmtime's source code to make losing the races described above more likely (by disabling certain assertions, inserting panic catches, and adding retry loops in a few places if we did not lose the race) we were able to incorrectly get a
funcref
to pass a type check that it should have failed, which would allow the CFI violation.Patches
This bug was originally introduced in Wasmtime 19's development of the WebAssembly GC proposal. This bug affects users who are not using the GC proposal, however, and affects Wasmtime in its default configuration even when the GC proposal is disabled. Wasmtime users using 19.0.0 and after are all affected by this issue. We have released the following Wasmtime versions, all of which have a fix for this bug:
Workarounds
If your application creates and drops Wasmtime types on multiple threads concurrently, there are no known workarounds. Users are encouraged to upgrade to a patched release.
References
The following APIs create or drop types, and therefore are affected by this race condition if performed on multiple threads concurrently and are all associated with the same
wasmtime::Engine
:wasmtime::FuncType::new
wasmtime::Func
wasmtime::Linker::func_*
wasmtime::ArrayType::new
wasmtime::StructType::new
wasmtime::Func::ty
wasmtime::Global::ty
wasmtime::Table::ty
wasmtime::Extern::ty
wasmtime::Export::ty
wasmtime::UnknownImportError::ty
wasmtime::ImportType::ty
wasmtime::ExportType::ty
wasmtime::Val::ty
wasmtime::Ref::ty
wasmtime::AnyRef::ty
wasmtime::EqRef::ty
wasmtime::ArrayRef::ty
wasmtime::StructRef::ty
wasmtime::FuncType
wasmtime::ArrayType
wasmtime::StructType
wasmtime::ExternType
wasmtime::GlobalType
wasmtime::TableType
wasmtime::ValType
wasmtime::RefType
wasmtime::HeapType
wasmtime::UnknownImportError
wasmtime::Linker
The change which introduced this bug was #7969
References