Update security best practices with journaling #2356
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
- Update how handle risks of outcalls to possibly untrusted canisters. - Update how to handle traps. - Add journaling section
domwoe
reviewed
Jan 18, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
…ces.md Reference the GoldDAO/gldt-swap implementation as an example of journaling.
oggy-dfin
reviewed
Jan 30, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Thanks a lot @andrew-lee-work ! LGTM, left a few comments / questions, see below. I think we need to decide what to do given @oggy-dfin 's concerns.
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
…y-best-practices.md Accept Robin's suggestion to fix a typo in the text he wrote. Co-authored-by: Robin Künzler <[email protected]>
…curity-best-practices.md Lower the section level of Journaling. Co-authored-by: Robin Künzler <[email protected]>
andrew-lee-work
commented
Feb 20, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
Old link was to a branch that had the underlying commit changed. The new tag link is fixed to a commit as long as normal version tag conventions are followed by the project.
…ing in recovery Apply guaranteed message ordering to simplify example recovery process.
…gers Emphasize manual recovery. This is because ICP ledger and ICRC ledgers make it difficult to determine whether a particular transaction has succeeded in an automated way.
Add another note on encouraging manual recovery when finding out the result of a call is difficult to automate.
Co-authored-by: Robin Künzler <[email protected]>
|
Follow-up issue: #2727 |
Add details on idempotent retries for task flows.
Give more context for journal example structures and flows and clarify the examples.
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
robin-kunzler
approved these changes
Apr 3, 2024
oggy-dfin
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
oggy-dfin
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
oggy-dfin
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
|
I believe all references to IC documentation need to be made relatively. So all https://internetcomputer.org/docs/current/... need to be replaced. If had someone change my PR to fix this but maybe we can try to do that ourselves? |
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
roelstorms
reviewed
Apr 4, 2024
docs/developer-docs/security/rust-canister-development-security-best-practices.md
Outdated
Show resolved
Hide resolved
Fix missing text in callback cleanup section. Co-authored-by: Roel Storms <[email protected]>
Add clarification that results may be lost if a trap occurs AND there is no self-call to commit it. Co-authored-by: oggy-dfin <[email protected]>
Co-authored-by: Roel Storms <[email protected]>
Co-authored-by: Roel Storms <[email protected]>
Suggestion from @roelstorms. Co-authored-by: Roel Storms <[email protected]>
Suggestion from @oggy-dfin. Co-authored-by: Robin Künzler <[email protected]>
This was referenced Apr 24, 2024
Suggestion from @roelstorms. Co-authored-by: Roel Storms <[email protected]>
Suggestion from @roelstorms. Co-authored-by: Roel Storms <[email protected]>
Add uniqueness requirement for transaction hash.
Remove section `Example journaling structures and flows`. Readers should refer to GoldDAO example instead.
andrew-lee-work
deleted the
andrew-lee-work/security-best-practices-journaling
branch
|
🤖 Preview build failed. |
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.
Thank you for your contribution to the IC Developer Portal.
Before submitting your Pull Request, please make sure that:
.github/CODEOWNERSfile according to your changes./sidebars.jsif any.