Upgrade Secrecy Crate

[ptdecker]

Hello!

Thank you for creating and supporting this crykptoki wrapper for Rust!

In using it, I noticed that the Secrecy crate dependency is for version 0.8.0. The current version of Secrecy is 0.10.3. Unfortunately, 0.10.0 was a significant re-write and moved from Secret to SecretBox. For our purposes, we try to keep our crate dependencies pretty current and would like to use 0.10.3. Are there any plans to adjust cryptoki to use secrecy 0.10.3 and absorb this breaking change? If no plans exist among the maintenance team, would you be open to an independent PR submission that makes this upgrade?

Thank you!

P. Todd Decker

[Jakuje]

I do not see a reason why updating to newer version should hurt. I think it was not done yet, because of the lack of the time an all fronts or nobody else noticed so far. I am also not aware of anybody working on that, so I believe if you have some cycles to contribute the changes, it will be welcomed and great addition for the next release!

[ptdecker]

Okay, @Jakuje, I can take this on. I assume the pattern as represented in the ci shell script is the current approach to testing? Or, do you all have an additional test suite vs SoftHSM or something? Also, could you assign me to this issue?

[wiktor-k]

Okay, @Jakuje, I can take this on. I assume the pattern as represented in the ci shell script is the current approach to testing? Or, do you all have an additional test suite vs SoftHSM or something? Also, could you assign me to this issue?

Thanks for your initiative! Tests require SoftHSM, indeed, but you can also just file a draft PR and see what comes out of it (modulo us clicking the "Approve" button continuously 😅 ).

[Jakuje]

For the CI, yes, you will see in the PR (or check previous ones). We have now softhsm and kryoptic in GH Actions.

[ptdecker]

Thank you @wiktor-k and @Jakuje . I have submitted draft #287. I can successfully build and test locally against SoftHSMv2 on my architecture. Looks like running CI needs maintainer approval.

I like to leave the code a little better than I found it so I cleaned up some minor grammar issues that my grammar checker was complaining about. I also added a readme file for installation notes as I had to take some extra steps in my environment to get everything working and the notes might benefit others who encounter the same. But, certainly, if you don't want these changes feel free to drop them.

[wiktor-k]

Looks like running CI needs maintainer approval.

Sadly, it will have to stay that way until you're a fully-fledged contributor (at least one PR merged). Hopefully, soon, but in the meantime we'll need to press the button so please bear with us 🙏

[ptdecker]

PR #287 has been merged into main. I assume this issue should be kept open until the next release out of main is officially published?

[ptdecker]

Ha! I said suggested this issue should probably be kept open until the next release is published but then I clumsily clicked "close with comment". This could be re-opened if appropriate.

[wiktor-k]

Nah, it's fine. You could've added "Fixes: #xyz" in your commit message for automatic close.

I guess that's the standard github flow (I agree that closing without released version is problematic but here we are 🤷).