Skip to content

feat: add tedge-init-hsm.sh convenience script#3870

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:feat-pkcs11-init-helper
Nov 26, 2025
Merged

feat: add tedge-init-hsm.sh convenience script#3870
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:feat-pkcs11-init-helper

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Add a convenience script to make it easier for users to initial different Hardware Security Modules (HSM) like TPM2, Nitrokey and SoftHSMs. This should make it easier to document the instructions for different HSM modules without having to go into the complexity of how to setup each, as some HSMs have some additional setup steps which could be daunting for new users.

With the introduction of the convenience script, the following changes were also included:

  • Use new helper script within tests where possible
  • Refactor pkcs11 Keywords to use more explicit names to make it easier to make some of the tests easier to read

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 24, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
743 0 3 743 100 2h22m19.904101999s

@reubenmiller reubenmiller added the theme:hsm Hardware Security Module related topics label Nov 24, 2025
@reubenmiller reubenmiller force-pushed the feat-pkcs11-init-helper branch from d915793 to 87e41cf Compare November 24, 2025 09:50
@reubenmiller reubenmiller marked this pull request as draft November 24, 2025 09:59
@reubenmiller reubenmiller self-assigned this Nov 24, 2025
@Bravo555 Bravo555 self-assigned this Nov 24, 2025
@reubenmiller reubenmiller added this to the 1.7.0 milestone Nov 24, 2025
@reubenmiller reubenmiller marked this pull request as ready for review November 25, 2025 04:08
Copy link
Copy Markdown
Member

@Bravo555 Bravo555 left a comment

Choose a reason for hiding this comment

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

Some inconsistencies in the tests, otherwise looks good.

Copy link
Copy Markdown
Member

@Bravo555 Bravo555 left a comment

Choose a reason for hiding this comment

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

Feedback addressed so approving, nice clean-up of the test suite and good PKCS11 utility for users.

Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller force-pushed the feat-pkcs11-init-helper branch from 8bafb21 to a7d4409 Compare November 26, 2025 12:38
@reubenmiller reubenmiller added this pull request to the merge queue Nov 26, 2025
Merged via the queue into thin-edge:main with commit dd6b54d Nov 26, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

theme:hsm Hardware Security Module related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants