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

Implement EncryptedData struct #3302

Merged
merged 4 commits into from
May 13, 2024
Merged

Implement EncryptedData struct #3302

merged 4 commits into from
May 13, 2024

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented May 10, 2024

Relates to #3303

Adds a new struct for representing an encrypted piece of data. As per @jhrozek's design doc, this struct will be serialized and stored in the database. This will be implemented in a later PR. For now, the Engine interface has been refactored to accept and return instances of these structs.

As per the design doc, I had originally intended to represent this struct as a protobuf struct. However, I realized that it would be far more straight forward to use a struct + JSON serialization for a type which will not be exposed by our API.

Tested locally.

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 #3292

Adds a new struct for representing an encrypted piece of data. As per
@jhrozek's design doc, this struct will be serialized and stored in the
database. This will be implemented in a later PR. For now, the Engine
interface has been refactored to accept and return instances of these
structs.
@dmjb dmjb requested a review from a team as a code owner May 10, 2024 14:44
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 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.

@coveralls
Copy link

coveralls commented May 10, 2024

Coverage Status

coverage: 49.337% (+0.04%) from 49.297%
when pulling 5ec9f7f on encrypted-data-protobuf
into b575d92 on main.

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

@jhrozek jhrozek left a comment

Choose a reason for hiding this comment

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

nice, I like it!

@dmjb dmjb merged commit a231e84 into main May 13, 2024
20 checks passed
@dmjb dmjb deleted the encrypted-data-protobuf branch May 13, 2024 09:45
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.

4 participants