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

Initial KeyStore implementation #3329

Merged
merged 4 commits into from
May 14, 2024
Merged

Initial KeyStore implementation #3329

merged 4 commits into from
May 14, 2024

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented May 14, 2024

Relates to #3304

Implement an interface which hides the specifics of loading an encryption key. This allows us to use a secret store or a key store directly in future.

Right now, the implementation uses a single key loaded from the config. In my next PR, I will generalize it to support multiple keys. This will require a new config structure.

Summary

Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.

Fixes #(related issue)

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

Relates to #3304

Implement an interface which hides the specifics of loading an
encryption key. This allows us to use a secret store or a key store
directly in future.

Right now, the implementation uses a single key loaded from the config.
In my next PR, I will generalize it to support multiple keys. This will
require a new config structure.
@dmjb dmjb requested a review from a team as a code owner May 14, 2024 11:17
Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Invisible Unicode Characters Detected.

@coveralls
Copy link

coveralls commented May 14, 2024

Coverage Status

coverage: 49.192% (+0.06%) from 49.135%
when pulling 76b4683 on key-store-part-i
into daccbc1 on main.

type aesCFBSAlgorithm struct {
encryptionKey []byte
}
// AES256CFBAlgorithm implements the AES-256-CFB algorithm
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The algorithm.go file has grown quite large, I split it in two as part of this PR.

@evankanderson evankanderson linked an issue May 14, 2024 that may be closed by this pull request
Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Invisible Unicode Characters Detected.

Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Mixed Scripts Detected.

Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Invisible Unicode Characters Detected.

Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Mixed Scripts Detected.

Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Invisible Unicode Characters Detected.

Copy link
Contributor

@stacklokbot stacklokbot left a comment

Choose a reason for hiding this comment

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

✅ No Mixed Scripts Detected.

@dmjb dmjb merged commit e7f9914 into main May 14, 2024
21 checks passed
@dmjb dmjb deleted the key-store-part-i branch May 14, 2024 20:47
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.

Hide encryption key fetching behind an interface
4 participants