Implement serving public keys for legacy nodes

[jschlyter]

Summary by CodeRabbit

Release Notes

• New Features

  • Added support for retrieving public keys from legacy node directories
  • Enhanced node key retrieval with fallback mechanism

• Dependencies

  • Updated dnstapir library to version 1.2.3
  • Added keymanager extras to library configuration

• Configuration

  • Introduced optional legacy nodes directory setting

• Testing

  • Added test coverage for legacy node public key retrieval scenarios

[coderabbitai]

Walkthrough

The pull request introduces a new mechanism for retrieving node public keys from a legacy nodes directory. A new function find_legacy_node is added to nodeman/nodes.py to locate and validate legacy node information. The Settings class in nodeman/settings.py is extended to support a configurable legacy nodes directory. The project's dnstapir dependency is updated to version 1.2.3 with an additional keymanager extra. New test cases are added to validate the legacy node public key retrieval functionality.

Changes

File	Change Summary
nodeman/nodes.py	- Added find_legacy_node() function to retrieve legacy node public keys - Modified get_node_public_key() to include legacy node fallback mechanism
nodeman/settings.py	- Added legacy_nodes_directory optional configuration
pyproject.toml	- Updated dnstapir dependency to v1.2.3 - Added keymanager extra to dependency
tests/test.toml	- Added legacy_nodes_directory = "tests/legacy" configuration
tests/test_api.py	- Added two new test functions for legacy node public key retrieval

Sequence Diagram

sequenceDiagram
    participant Client
    participant NodeAPI
    participant LegacyNodeStorage
    
    Client->>NodeAPI: Request Node Public Key
    NodeAPI->>NodeAPI: Attempt Primary Node Lookup
    alt Primary Lookup Fails
        NodeAPI->>LegacyNodeStorage: Find Legacy Node
        alt Legacy Node Found
            LegacyNodeStorage-->>NodeAPI: Return Public Key
            NodeAPI-->>Client: Return Public Key
        else Legacy Node Not Found
            NodeAPI-->>Client: Return Error
        end
    else Primary Lookup Succeeds
        NodeAPI-->>Client: Return Public Key
    end

Loading

Possibly related PRs

• Send enrollment key as JWK #34: Changes in node enrollment key management align with the new find_legacy_node function's error handling
• Generic enrollment keys #36: Introduction of TapirNodeEnrollment class relates to enhanced key management process

Poem

🐰 In the realm of nodes, a legacy tale unfolds,
Where keys are found in directories of old,
A rabbit's quest for public secrets bright,
Traversing paths with algorithmic might!
Legacy nodes, now found with grace and ease,
Code hopping through directories with a gentle breeze! 🔑

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb54e5e and bc6ccdb.

⛔ Files ignored due to path filters (2)

• poetry.lock is excluded by !**/*.lock
• tests/legacy/legacy.pem is excluded by !**/*.pem

📒 Files selected for processing (5)

• nodeman/nodes.py (4 hunks)
• nodeman/settings.py (2 hunks)
• pyproject.toml (1 hunks)
• tests/test.toml (1 hunks)
• tests/test_api.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• tests/test.toml

🔇 Additional comments (6)

nodeman/settings.py (1)

5-14: LGTM! Clean addition of legacy nodes directory configuration.

The changes properly integrate the new optional legacy nodes directory setting using Pydantic's DirectoryPath for path validation.

Also applies to: 91-92

nodeman/nodes.py (2)

58-69: LGTM! Well-structured legacy node lookup implementation.

The function properly:

• Validates node names
• Handles file reading errors
• Converts PEM to JWK format
• Returns consistent TapirNode structure

---

220-226: LGTM! Clean integration of legacy node fallback.

The changes elegantly integrate legacy node lookup while maintaining backward compatibility:

• Only attempts legacy lookup when configured
• Preserves original error if legacy lookup fails
• Maintains existing error handling pattern

tests/test_api.py (2)

434-446: LGTM! Comprehensive testing of legacy node key retrieval.

The test thoroughly validates:

• Both JWK and PEM format responses
• Successful key parsing in both formats

---

448-454: LGTM! Good error case coverage.

The test properly verifies that invalid node names are rejected with a 400 status code.

pyproject.toml (1)

14-14: Verify compatibility with dnstapir v1.2.3.

The dependency update and addition of the keymanager extra look good, but since this is a direct git dependency, please ensure:

• The version bump doesn't introduce breaking changes
• The keymanager functionality is stable in v1.2.3

Run this script to check the changelog between versions:

✅ Verification successful

Dependency update to v1.2.3 is compatible

The changes between v1.2.0 and v1.2.3 are focused on key management improvements and dependency updates. No breaking changes were found. The addition of the keymanager extra is well-timed as v1.2.3 includes several key management enhancements:

• Improved key ID pattern support
• Added URL validation for key resolvers
• Exposed key ID validator functionality

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check dnstapir changes between v1.2.0 and v1.2.3

# Clone the repo to a temp directory
git clone https://github.com/dnstapir/python-dnstapir.git /tmp/dnstapir
cd /tmp/dnstapir

# Check commits between versions
git log --oneline v1.2.0..v1.2.3

Length of output: 186

---

Script:

#!/bin/bash
# Check if repository exists and its basic information
gh repo view dnstapir/python-dnstapir

# List available tags
git ls-remote --tags https://github.com/dnstapir/python-dnstapir.git

Length of output: 672

---

Script:

#!/bin/bash
# Get the commit messages between v1.2.0 and v1.2.3
gh api repos/dnstapir/python-dnstapir/compare/v1.2.0...v1.2.3 --jq '.commits[].commit.message'

# Check for keymanager related files
fd keymanager /tmp/dnstapir -t f

# Look for breaking changes markers in the code
rg -i "breaking|deprecated" /tmp/dnstapir

Length of output: 1189

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[jschlyter]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.