Fix out-of-bounds access possibility in safe code. #18
Conversation
This file contains hidden or 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
With the `id` and `tree` fields of `NodeRef` and `NodeMut` being public, it was possible to assign to them. For example, it was possible to build a `NodeMut` for large ID/index in a small tree/Vec. Since some APIs use unchecked indexing, this would let users of this library cause out-of-bounds access in a `Vec` without writing `unsafe` code themselves. This deprecates the fields, and instead providing read-only access via accessor methods. This lets dependent crates realize that there is a problem they might need to fix.
|
Yikes. If I remember correctly this used to be the API but at some point I switched to public fields thinking that |
With the `id` and `tree` fields of `NodeRef` and `NodeMut` being public, it was possible to assign to them. For example, it was possible to build a `NodeMut` for large ID/index in a small tree/Vec. Since some APIs use unchecked indexing, this would let users of this library cause out-of-bounds access in a `Vec` without writing `unsafe` code themselves. This commit fixes that issue by making the fields private and instead providing read-only access via accessor methods. Now the fields can only be set by the `ego-tree` crate, which can make sure to only ever use an ID that is in-bounds for a given tree.
SimonSapin
force-pushed
the
out-of-bounds
branch
from
cbe9cf6 to
aba138c
Compare
|
I’ve added an intermediate commit with a SemVer-compatible version that keeps the fields public but deprecates them. Publishing both commits might be best to do now. |
|
Great idea. Thanks |
|
0.5.1 and 0.6.0 published |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the
idandtreefields ofNodeRefandNodeMutbeing public, it was possible to assign to them. For example, it was possible to build aNodeMutfor large ID/index in a small tree/Vec. Since some APIs use unchecked indexing, this would let users of this library cause out-of-bounds access in aVecwithout writingunsafecode themselves.This commit fixes that issue by making the fields private and instead providing read-only access via accessor methods. Now the fields can only be set by the
ego-treecrate, which can make sure to only ever use an ID that is in-bounds for a given tree.