Move reusable code from `keylime-agent` to the `keylime` library #1018

ansasaki · 2025-06-04T12:30:29Z

This moves the code that can be used by other applications, such as the push-attestation prototype, to the keylime library.

codecov · 2025-06-04T13:35:19Z

Codecov Report

Attention: Patch coverage is 63.28671% with 105 lines in your changes missing coverage. Please review.

Project coverage is 62.10%. Comparing base (07167a0) to head (c0ed8f1).
Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
keylime/src/permissions.rs	68.85%	38 Missing ⚠️
keylime/src/context_info.rs	42.30%	30 Missing ⚠️
keylime/src/error.rs	10.00%	9 Missing ⚠️
keylime/src/config/base.rs	70.37%	8 Missing ⚠️
keylime-agent/src/main.rs	0.00%	6 Missing ⚠️
keylime-agent/src/payloads.rs	58.33%	5 Missing ⚠️
keylime/src/config/env.rs	87.50%	3 Missing ⚠️
keylime/src/config/push_model.rs	57.14%	3 Missing ⚠️
keylime/src/version.rs	33.33%	2 Missing ⚠️
keylime/src/json_wrapper.rs	94.44%	1 Missing ⚠️

Additional details and impacted files

Flag	Coverage Δ
e2e-testsuite	`62.10% <63.28%> (-7.83%)`	⬇️
upstream-unit-tests	`62.10% <63.28%> (-7.83%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
keylime-agent/src/agent_handler.rs	`58.69% <ø> (-2.18%)`	⬇️
keylime-agent/src/api.rs	`77.38% <ø> (ø)`
keylime-agent/src/errors_handler.rs	`49.48% <100.00%> (-1.04%)`	⬇️
keylime-agent/src/keys_handler.rs	`65.45% <ø> (ø)`
keylime-agent/src/notifications_handler.rs	`66.66% <ø> (ø)`
keylime-agent/src/quotes_handler.rs	`51.73% <ø> (ø)`
keylime-agent/src/revocation.rs	`70.10% <ø> (ø)`
keylime-push-model-agent/src/main.rs	`80.43% <ø> (+1.08%)`	⬆️
keylime-push-model-agent/src/registration.rs	`87.50% <ø> (ø)`
keylime-push-model-agent/src/struct_filler.rs	`89.02% <ø> (ø)`
... and 15 more

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ansasaki · 2025-06-04T15:00:24Z

The tests need to be updated to allow debug messages coming from the library. I proposed the PR RedHat-SP-Security/keylime-tests#779 making that change.

I temporarily changed the tests to use that PR code to confirm it is the only required change

ansasaki · 2025-06-04T16:36:56Z

/packit retest-failed

ansasaki · 2025-06-05T07:58:27Z

The updated tests were merged and I dropped the temporary commit changing the location of the tests.
This is ready for review.

ansasaki · 2025-06-06T10:08:05Z

@sergio-correia @sarroutbi I think the coverage for the error.rs is not correct. I would say you can ignore it for now. We should aim for removing the errors.rs file completely as part of the refactoring

sarroutbi · 2025-06-10T08:55:06Z

keylime/src/config/env.rs

@@ -0,0 +1,210 @@
+// SPDX-License-Identifier: Apache-2.0


Is file header necessary? I have not included it in the latest changes but I doubt if it should be added or not. If so, I will create an additional PR for the ones that don't contain it

sarroutbi · 2025-06-10T08:56:15Z

keylime/src/json_wrapper.rs

@@ -0,0 +1,87 @@
+use serde::{Deserialize, Serialize};


I would try to homogeneize files and and/remove license header

sarroutbi

Minor comments regarding file headers (we should homogeneize them, but it can be done in a different PR). Rest of changes LGTM

Move the permissions code to the library as the permissions module. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

The following changes were made: - Moved keylime/src/global_config.rs to keylime/src/config/errors.rs - Moved keylime-agent/src/config.rs to keylime/src/config/base.rs - Moved the EnvConfig structure to the dedicated file keylime/src/config/env.rs - Moved the SUPPORTED_API_VERSIONS value from keylime-agent/src/api.rs to keylime/src/config/base.rs - Added temporary values for DEFAULT_PUSH_API_VERSIONS and DEFAULT_PUSH_EK_HANDLE in keylme/src/config/push_model.rs - Modified other files as necessary Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Add specific error type ContextInfoError for the context_info module and remove the usage of expect() to avoid panic. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

The structures APIVersion defined in common.rs was equivalent to the Version structure defined in the library. Remove APIVersion in favor of the Version structure from the library. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Move the tests related to the AgentData structure from the keylime-agent/src/common.rs to keylime/src/agent_data.rs Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Move the JsonWrapper structure from common.rs to the library, effectively making the common.rs empty. Remove the common.rs file. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

ansasaki · 2025-06-10T11:42:39Z

@sarroutbi Hi, could you please take a look again? I added a specific error type ContextInfoError to remove the expect() usage in the code. I overlooked it during my review of your code, but please avoid using unwrap() or expect() in the code as it will generate panic which kills the agent. It is acceptable to use them as part of the tests, but not as part of the actual code. I know we still have some of them spread around, but ideally we should remove all of them from the code.

sarroutbi

LGTM

ansasaki requested review from sarroutbi, sergio-correia and THS-on June 4, 2025 12:30

keylime-bot assigned sergio-correia, sarroutbi and THS-on Jun 4, 2025

ansasaki mentioned this pull request Jun 4, 2025

Enable logs generated by the keylime library RedHat-SP-Security/keylime-tests#779

Merged

ansasaki marked this pull request as draft June 4, 2025 15:00

ansasaki force-pushed the lib_config branch from 1936de6 to c2f8b09 Compare June 5, 2025 07:57

ansasaki marked this pull request as ready for review June 5, 2025 07:58

ansasaki force-pushed the lib_config branch from 0396a67 to 0b0c096 Compare June 5, 2025 12:58

sarroutbi reviewed Jun 10, 2025

View reviewed changes

sarroutbi approved these changes Jun 10, 2025

View reviewed changes

ansasaki added 2 commits June 10, 2025 11:00

lib: Move permissions.rs from keylime-agent to the lib

ef7ccad

Move the permissions code to the library as the permissions module. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

config: Rename push_model_config to push_model

8d05896

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

keylime-bot unassigned sarroutbi Jun 10, 2025

ansasaki added 8 commits June 10, 2025 11:18

lib: Rename keylime_error.rs as error.rs

6faa653

Add specific error type ContextInfoError for the context_info module and remove the usage of expect() to avoid panic. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

keylime_agent: Move secure_mount.rs to the library

f24bea0

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

lib/agent_data: Move agent_data related tests from common

f03999b

Move the tests related to the AgentData structure from the keylime-agent/src/common.rs to keylime/src/agent_data.rs Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

keylime-agent: move JsonWrapper from common.rs to the library

88f35a4

Move the JsonWrapper structure from common.rs to the library, effectively making the common.rs empty. Remove the common.rs file. Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

lib/permissions: Add unit tests

1b0cf39

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

lib/config/base.rs: Add more unit tests

c0ed8f1

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

ansasaki force-pushed the lib_config branch from 9507f43 to c0ed8f1 Compare June 10, 2025 11:24

sarroutbi approved these changes Jun 10, 2025

View reviewed changes

ansasaki merged commit 4f0360d into keylime:master Jun 10, 2025
11 of 12 checks passed

ansasaki deleted the lib_config branch June 10, 2025 14:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Move reusable code from `keylime-agent` to the `keylime` library #1018

Move reusable code from `keylime-agent` to the `keylime` library #1018

Uh oh!

ansasaki commented Jun 4, 2025

Uh oh!

codecov bot commented Jun 4, 2025 •

edited

Loading

Uh oh!

ansasaki commented Jun 4, 2025

Uh oh!

ansasaki commented Jun 4, 2025

Uh oh!

ansasaki commented Jun 5, 2025 •

edited

Loading

Uh oh!

ansasaki commented Jun 6, 2025

Uh oh!

sarroutbi Jun 10, 2025

Uh oh!

sarroutbi Jun 10, 2025

Uh oh!

sarroutbi left a comment

Uh oh!

ansasaki commented Jun 10, 2025

Uh oh!

sarroutbi left a comment

Uh oh!

Uh oh!

Uh oh!

Move reusable code from keylime-agent to the keylime library #1018

Move reusable code from keylime-agent to the keylime library #1018

Uh oh!

Conversation

ansasaki commented Jun 4, 2025

Uh oh!

codecov bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ansasaki commented Jun 4, 2025

Uh oh!

ansasaki commented Jun 4, 2025

Uh oh!

ansasaki commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ansasaki commented Jun 6, 2025

Uh oh!

sarroutbi Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

sarroutbi Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

sarroutbi left a comment

Choose a reason for hiding this comment

Uh oh!

ansasaki commented Jun 10, 2025

Uh oh!

sarroutbi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Move reusable code from `keylime-agent` to the `keylime` library #1018

Move reusable code from `keylime-agent` to the `keylime` library #1018

codecov bot commented Jun 4, 2025 •

edited

Loading

ansasaki commented Jun 5, 2025 •

edited

Loading