-
Notifications
You must be signed in to change notification settings - Fork 47
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
Add DepthLimiter
and adapt to the Read/WriteXDR
#158
Merged
Merged
Conversation
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 reverts commit 6a6a6a4.
jayz22
changed the title
[WIP] Add
Add Jul 10, 2023
DepthLimiter
and adapt to the Read/WriteXDRDepthLimiter
and adapt to the Read/WriteXDR
graydon
requested changes
Jul 11, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally looking good! A few nits, a few deeper design questions.
graydon
approved these changes
Jul 14, 2023
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.
This is the xdrgen side of changed needed for stellar/rs-soroban-env#861
Generated rs-stellar-xdr: stellar/rs-stellar-xdr#281
The corresponding env PR is stellar/rs-soroban-env#904
DepthLimiter
and implements it on two new structuresDepthLimitedRead
andDepthLimitedWrite
, which replace the normalR: Read
andW: Write
in[Read,Write]Xdr
.enter
andleave
. Thus limiting the number of recursions on[read_ write_]xdr
calls.pub const DEFAULT_MAX_DEPTH_LIMIT: u32
which is used for scenarios where DepthLimited structure is constructed internally (from_xdr(bytes)
andfrom_xdr_base64(bytes)
). I don't quite like the fact that this is an internal constant, I think ideally this should be externally defined, like the other scenarios where the user constructs the DepthLimited struct. This also means the same workflows may have two different limits, depending on which api to call.But passing an additional u32 into these apis makes the UX hideous, and I've checked there is no
extern std::uint32_t
(how xdrpp does it) equivalent in Rust, and Rust doesn't like static mutable variables (I experimented with it in one commit but it would require turning off the "no-unsafe" guard so I reverted it). So I just decided using a pub const here is the best compromise (I can think of, would much welcome suggestions) for UX._with_depth_limit
version offrom_xdr
to allow user-specified depth limits, and having one version calling another. This is a fair compromise that allows the user deal the the inconsistency mentioned above.cc @graydon @anupsdf