Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unsoundness in BytesRefHash::pool #19

Open
lwz23 opened this issue Dec 9, 2024 · 2 comments
Open

Unsoundness in BytesRefHash::pool #19

lwz23 opened this issue Dec 9, 2024 · 2 comments

Comments

@lwz23
Copy link

lwz23 commented Dec 9, 2024

Hello, thank you for your contribution in this project, I am scanning the unsoundness problem in rust project.
I notice the following code:

pub struct BytesRefHash {
    pub pool: *mut ByteBlockPool,
    ................................
}

impl BytesRefHash {
........................................
    pub fn byte_pool(&self) -> &ByteBlockPool {
        unsafe { &*self.pool }
    }

    fn pool_mut(&mut self) -> &mut ByteBlockPool {
        unsafe { &mut *self.pool }
    }
.......................................
}

Considering that pub mod core, BytesRefHash is pub struct and pool is a pub field, I assume that users can directly manipulate this field. This potential situation could result in self.pool being a null pointer, and directly dereferencing it might trigger undefined behavior (UB). For safety reasons, I felt it necessary to report this issue. If you have performed checks elsewhere that ensure this is safe, please don’t take offense at my raising this issue.
If there is no external using for BytesRefHash, maybe it should not be marked as pub, at least for its field should not be mark as pub.

@lwz23
Copy link
Author

lwz23 commented Dec 9, 2024

same problem for LongsPtr::longs

unsafe { &mut (*self.longs) }

@lwz23
Copy link
Author

lwz23 commented Dec 16, 2024

ping

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant