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

Rework leaf node extensions to work via parameters rather than as a c… #196

Merged
merged 6 commits into from
Oct 17, 2024

Conversation

CaioSym
Copy link
Contributor

@CaioSym CaioSym commented Sep 30, 2024

Issues:

Resolves #195

Description of changes:

  • Fully remove ClientConfig.leaf_node_extensions AND ClientConfig.key_package_extensions (Breaking change.)
    • I believe breaking the existing API is necessary to ensure we avoid some of the undesirable behaviours in the discussion section
  • Allow leaf_node_extensions to be passed as parameters when executing the following operations:
    • Creating a group (ie, setting the LNEs for the member that creates the group)
    • Generating a KeyPackage / KeyPackage message
    • Making Commits (via a property in CommitBuilder)
      • If the property is not passed, then the commit code should be modified to preserve whatever value is currently set in LeadNode.extensions rather than overwrite it
    • Making update proposals
      • If the property is not passed, then the commit code should be modified to preserve whatever value is currently set in LeadNode.extensions rather than overwrite it
  • Allow key_package_extensions to be passed as parameters when executing the following operations:
    • Generating a KeyPackage / KeyPackage message

Call-outs:

This is a breaking change as it reworks several methods in the public API. We could mitigate some of this by introducing more methods that roll out default LNEs.

Testing:

Current unit tests already cover all of the affected areas. All tests are passing. Some tests were modified so as to leverage the new apis introduced in this PR.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT license.

@CaioSym CaioSym requested a review from a team as a code owner September 30, 2024 21:25
mulmarta
mulmarta previously approved these changes Oct 2, 2024
Copy link
Contributor

@mulmarta mulmarta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CaioSym ! Left a couple of nit comments.

@tomleavy tomleavy merged commit c710afa into awslabs:main Oct 17, 2024
17 checks passed
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

Successfully merging this pull request may close these issues.

Improve Leaf Node Extension Management
3 participants