-
Notifications
You must be signed in to change notification settings - Fork 19
feat(policy): Modify KAS indexer to support legacy keys. #2616
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
Conversation
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.
Summary of Changes
Hello @c-r33d, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the Key Access Server (KAS) indexer by introducing the capability to filter keys based on their 'legacy' status. The core change involves modifying key listing and finding functions across the key management stack to accept a legacyOnly
or includeLegacy
parameter, allowing consumers to retrieve only legacy keys or exclude them as needed. This provides more granular control over key discovery and management within the system.
Highlights
- Key Indexing Interface Update: The
KeyIndex
interface and its various implementations (DelegatingKeyService
,InProcessProvider
,KeyIndexer
) have been updated to include alegacyOnly
boolean parameter in theirListKeys
method. This new parameter enables explicit filtering of keys based on their legacy status. - Legacy Key Filtering Logic: The
ListKeys
implementations now incorporate logic to filter the returned keys, ensuring that only those marked as legacy are returned when thelegacyOnly
parameter is set totrue
. This includes propagating thelegacyOnly
flag down to thekasregistry.ListKeysRequest
. KeyAdapter.IsLegacy()
Implementation: TheKeyAdapter
'sIsLegacy()
method has been updated to correctly retrieve the legacy status from the underlyingpolicy.AsymmetricKey
protobuf message, rather than always returningfalse
. This allows the system to accurately identify legacy keys.FindKeyByAlgorithm
Enhancement: TheKeyIndexer
'sFindKeyByAlgorithm
method has been extended to support filtering keys based on their legacy status via anincludeLegacy
parameter, providing more granular control over key discovery.- Test Coverage: New unit tests have been added to verify the correct behavior of the
KeyAdapter.IsLegacy()
method and theListKeys
filtering functionality inDelegatingKeyService
andMockSecurityProvider
, ensuring the new features work as expected.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Old keys, new keys, Filtered now with careful hand, Legacy finds peace.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request introduces support for filtering legacy keys in the KAS indexer by modifying the ListKeys
and FindKeyByAlgorithm
methods. The changes correctly propagate the new legacyOnly
and includeLegacy
parameters through the call chain, and the tests have been updated accordingly.
However, I've identified two critical issues in the implementation within service/kas/key_indexer.go
where the new filtering logic is not correctly implemented, leading to incorrect behavior. The provided suggestions should resolve these issues. Please review the comments for details.
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Standard Benchmark Metrics Skipped or FailedBulk Benchmark Results
TDF3 Benchmark Results:
NANOTDF Benchmark Results:
|
Proposed Changes
1.) Create a new function for key_index called ListKeysWith allowing developers to pass in common ListKeyOptions
2.) Modify ListKeys/FindKeyByAlgorithm within key_indexer to support listing legacy keys.
Checklist
Testing Instructions