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

Update security best practices with journaling #2356

Merged

Commits on Jan 18, 2024

  1. Update security best practices with journaling

    - Update how handle risks of outcalls to possibly untrusted canisters.
    - Update how to handle traps.
    - Add journaling section
    andrew-lee-work authored Jan 18, 2024
    Configuration menu
    Copy the full SHA
    d8cc528 View commit details
    Browse the repository at this point in the history

Commits on Jan 29, 2024

  1. Add journaling impl to rust-canister-development-security-best-practi…

    …ces.md
    
    Reference the GoldDAO/gldt-swap implementation as an example of journaling.
    andrew-lee-work authored Jan 29, 2024
    Configuration menu
    Copy the full SHA
    f511dbb View commit details
    Browse the repository at this point in the history

Commits on Feb 13, 2024

  1. Update docs/developer-docs/security/rust-canister-development-securit…

    …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]>
    andrew-lee-work and robin-kunzler authored Feb 13, 2024
    Configuration menu
    Copy the full SHA
    7bf8b31 View commit details
    Browse the repository at this point in the history
  2. Lower the level of Journaling Section in rust-canister-development-se…

    …curity-best-practices.md
    
    
    Lower the section level of Journaling.
    
    Co-authored-by: Robin Künzler <[email protected]>
    andrew-lee-work and robin-kunzler authored Feb 13, 2024
    Configuration menu
    Copy the full SHA
    9467697 View commit details
    Browse the repository at this point in the history

Commits on Feb 20, 2024

  1. Update link to be more permanent

    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.
    andrew-lee-work authored Feb 20, 2024
    Configuration menu
    Copy the full SHA
    d37080d View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. Security best practices / Journaling: Invoke guaranteed message order…

    …ing in recovery
    
    Apply guaranteed message ordering to simplify example recovery process.
    andrew-lee-work authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    e53f6b6 View commit details
    Browse the repository at this point in the history
  2. Security-best-practices/journaling: Emphasize manual recovery for led…

    …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.
    andrew-lee-work authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    0b8139e View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e0af220 View commit details
    Browse the repository at this point in the history
  4. Security-best-practices / Journaling: Another note on manually recovery

    Add another note on encouraging manual recovery when finding out the result of a call is difficult to automate.
    andrew-lee-work authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    e4910c9 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    4568b84 View commit details
    Browse the repository at this point in the history
  6. Security-best-practices/Journaling: Detail retries

    Add details on idempotent retries for task flows.
    andrew-lee-work authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    3d04fea View commit details
    Browse the repository at this point in the history
  7. Security-best-practices/Journaling: Improve journaling example

    Give more context for journal example structures and flows and clarify the examples.
    andrew-lee-work authored Apr 2, 2024
    Configuration menu
    Copy the full SHA
    f351e74 View commit details
    Browse the repository at this point in the history

Commits on Apr 4, 2024

  1. Security-best-practices/callback-cleanup: Fix missing text

    Fix missing text in callback cleanup section.
    
    Co-authored-by: Roel Storms <[email protected]>
    andrew-lee-work and roelstorms authored Apr 4, 2024
    Configuration menu
    Copy the full SHA
    a7f3320 View commit details
    Browse the repository at this point in the history
  2. Security-best-practices/Journaling: Add clarification on trap handling

    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]>
    andrew-lee-work and oggy-dfin authored Apr 4, 2024
    Configuration menu
    Copy the full SHA
    ceae487 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    6f60ed9 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    f8dbdc5 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    7d23528 View commit details
    Browse the repository at this point in the history

Commits on Apr 24, 2024

  1. Security-best-practices/Journaling: Improve wording

    Suggestion from @roelstorms.
    
    Co-authored-by: Roel Storms <[email protected]>
    andrew-lee-work and roelstorms authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    4ac7190 View commit details
    Browse the repository at this point in the history
  2. Security-best-practices/Journaling: Improve wording

    Suggestion from @oggy-dfin.
    
    Co-authored-by: Robin Künzler <[email protected]>
    andrew-lee-work and robin-kunzler authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    1f67a3b View commit details
    Browse the repository at this point in the history
  3. Security-best-practices/Journaling: Improve wording

    Suggestion from @roelstorms.
    
    Co-authored-by: Roel Storms <[email protected]>
    andrew-lee-work and roelstorms authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    0b812dd View commit details
    Browse the repository at this point in the history
  4. Security-best-practices/Journaling: Improve wording

    Suggestion from @roelstorms.
    
    Co-authored-by: Roel Storms <[email protected]>
    andrew-lee-work and roelstorms authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    0e99e92 View commit details
    Browse the repository at this point in the history
  5. Security-best-practices/Journaling: Add tx uniqueness requirement

    Add uniqueness requirement for transaction hash.
    andrew-lee-work authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    543a6db View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    2a8e016 View commit details
    Browse the repository at this point in the history
  7. Security-best-practices/Journaling: Remove example section

    Remove section `Example journaling structures and flows`. Readers should refer to GoldDAO example instead.
    andrew-lee-work authored Apr 24, 2024
    Configuration menu
    Copy the full SHA
    9dc6f9b View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    8764170 View commit details
    Browse the repository at this point in the history