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

Add config file including all options #172

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Conversation

sosthene-nitrokey
Copy link
Contributor

This PR adds an p11nethsm.example.conf including and explaining all the options. It also adds a unit test that checks all the values of this file once parsed.

@sosthene-nitrokey
Copy link
Contributor Author

The test will conflict with #165

Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c292adc) 90.81% compared to head (02fafff) 90.88%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #172      +/-   ##
==========================================
+ Coverage   90.81%   90.88%   +0.07%     
==========================================
  Files          31       31              
  Lines        6410     6450      +40     
==========================================
+ Hits         5821     5862      +41     
+ Misses        589      588       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

# Optional log level, acceptable values are Trace, Debug, Info, Warn and Error
log_level: Debug

# Each "slot" represents a NetHSM server
Copy link
Member

Choose a reason for hiding this comment

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

Actually, it’s a set of servers with the same users and keys (or at least a common subset), isn’t it? Not sure if there is a preferred term for that setup. Maybe “NetHSM cluster”?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah a slot represent a cluster of NetHSM that can be accessed with the same credentials.
https://docs.nitrokey.com/nethsm/pkcs11-setup#instances

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was taken verbatim from the docs.
I Will fix it both here and there.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah that's my bad. I should add that the slot name comes from PKCS#11 where it's like a card reader or HSM port.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once this is merged I will udpate it also in the docs.

@sosthene-nitrokey sosthene-nitrokey force-pushed the document-format branch 2 times, most recently from ab8ed2d to 6a8e20c Compare January 16, 2024 14:54
sosthene-nitrokey added a commit to Nitrokey/nitrokey-documentation that referenced this pull request Jan 16, 2024
@sosthene-nitrokey sosthene-nitrokey merged commit 4ea9a42 into main Jan 17, 2024
5 checks passed
@sosthene-nitrokey sosthene-nitrokey deleted the document-format branch January 17, 2024 09:34
sosthene-nitrokey added a commit to Nitrokey/nitrokey-documentation that referenced this pull request Jan 24, 2024
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.

3 participants