Skip to content

Commit

Permalink
clarify docs and changelog for 1446 (#1457)
Browse files Browse the repository at this point in the history
Signed-off-by: Craig Disselkoen <cdiss@amazon.com>
  • Loading branch information
cdisselkoen authored Feb 7, 2025
1 parent bc9df26 commit 3eb73c5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
6 changes: 5 additions & 1 deletion cedar-policy/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ Cedar Language Version: TBD

### Fixed

- Assume sufficient stack space when it cannot be determined (#1446, resolving #1443)
- Assume sufficient stack space when it cannot be determined (#1446, resolving #1443).
Note that on platforms not supported by `stacker` (e.g., Wasm, Android), this means
that large inputs may result in stack overflows and crashing the process.
On all platforms supported by `stacker` (Linux, macOS, ...), Cedar will
continue to return the graceful error `RecursionLimit` instead of crashing.

## [4.3.1] - Coming soon
Cedar Language Version: 4.2
Expand Down
9 changes: 6 additions & 3 deletions cedar-policy/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -872,9 +872,12 @@ impl Authorizer {
///
/// The authorizer uses the `stacker` crate to manage stack size and tries to use a sane default.
/// If the default is not right for you, you can try wrapping the authorizer or individual calls
/// to `is_authorized` in `stacker::grow`. Note that `stacker` does not provide support in some
/// platforms like `wasm32`. In such cases, the authorizer will assume that the stack size is
/// sufficient.
/// to `is_authorized` in `stacker::grow`.
/// Note that on platforms not supported by `stacker` (e.g., Wasm, Android),
/// the authorizer will simply assume that the stack size is sufficient. As a result, large inputs
/// may result in stack overflows and crashing the process.
/// But on all platforms supported by `stacker` (Linux, macOS, ...), Cedar will return the
/// graceful error `RecursionLimit` instead of crashing.
/// ```
/// # use cedar_policy::{Authorizer, Context, Entities, EntityId, EntityTypeName,
/// # EntityUid, Request,PolicySet};
Expand Down

0 comments on commit 3eb73c5

Please sign in to comment.