feat: use verifying key from base64 #217
Conversation
Signed-off-by: Smuu <18609909+Smuu@users.noreply.github.com>
WalkthroughThis pull request introduces changes to handle verifying keys using base64 encoding across the CLI and keys components. A new dependency Changes
Sequence DiagramsequenceDiagram
participant CLI as CLI Application
participant Config as Configuration
participant Keys as Verifying Keys
CLI->>Config: Request Verifying Key
Config-->>CLI: Return Base64 Encoded Key
CLI->>Keys: Decode Base64 Key
Keys-->>CLI: Provide Decoded Verifying Key
CLI->>CLI: Process Command
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
crates/cli/src/main.rs (1)
47-51: Standardize error handling across similar code paths.The error handling for
VerifyingKey::from_base64is duplicated in both the LightClient and FullNode commands. Consider extracting this into a helper function to ensure consistent error handling.+fn parse_verifying_key(base64: Option<String>) -> std::io::Result<VerifyingKey> { + base64 + .ok_or_else(|| Error::new(ErrorKind::InvalidInput, "verifying key not found"))? + .try_into() + .map_err(|e: anyhow::Error| Error::new(ErrorKind::InvalidInput, e.to_string())) +}Then use it in both places:
- let verifying_key_base64 = config - .verifying_key - .ok_or_else(|| Error::new(ErrorKind::InvalidInput, "verifying key not found"))?; - let prover_vk = VerifyingKey::from_base64(verifying_key_base64) - .map_err(|e: anyhow::Error| Error::new(ErrorKind::InvalidInput, e.to_string()))?; + let prover_vk = parse_verifying_key(config.verifying_key)?;Also applies to: 158-162
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (3)
crates/cli/Cargo.toml(1 hunks)crates/cli/src/main.rs(4 hunks)crates/keys/src/verifying_keys.rs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: unused dependencies
- GitHub Check: unit-test
- GitHub Check: integration-test
- GitHub Check: build-and-push-image
🔇 Additional comments (3)
crates/cli/Cargo.toml (1)
36-36: LGTM!The addition of
prism-serdeas a workspace dependency is appropriate for implementing base64 encoding/decoding functionality.crates/keys/src/verifying_keys.rs (1)
253-257: LGTM! Clean implementation of ToBase64.The implementation correctly leverages the existing
to_bytes()method and is consistent with the existingFromBase64implementation.crates/cli/src/main.rs (1)
101-101: Review security implications of logging verifying keys.Logging public keys at INFO level might expose sensitive information in logs. Consider:
- Logging at DEBUG level instead
- Logging only when explicitly configured
- Logging a hash or truncated version of the key
| let _verifying_key_algorithm = | ||
| CryptoAlgorithm::from_str(&config.verifying_key_algorithm).map_err(|_| { | ||
| Error::new( | ||
| ErrorKind::InvalidInput, | ||
| "invalid verifying key algorithm format", | ||
| ) | ||
| })?; |
There was a problem hiding this comment.
Remove the underscore prefix from _verifying_key_algorithm.
The variable is marked as unused with an underscore prefix, but it's actually used in the code. This is misleading.
- let _verifying_key_algorithm =
+ let verifying_key_algorithm =
CryptoAlgorithm::from_str(&config.verifying_key_algorithm).map_err(|_| {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| let _verifying_key_algorithm = | |
| CryptoAlgorithm::from_str(&config.verifying_key_algorithm).map_err(|_| { | |
| Error::new( | |
| ErrorKind::InvalidInput, | |
| "invalid verifying key algorithm format", | |
| ) | |
| })?; | |
| let verifying_key_algorithm = | |
| CryptoAlgorithm::from_str(&config.verifying_key_algorithm).map_err(|_| { | |
| Error::new( | |
| ErrorKind::InvalidInput, | |
| "invalid verifying key algorithm format", | |
| ) | |
| })?; |
|
Done in #225 |
Summary by CodeRabbit
New Features
Dependency Updates
prism-serdeas a project dependencyImprovements