Relax requirements around PKCS#11 config

MatthiasValvekens / pyHanko

pyHanko: sign and stamp PDF files

MIT License

494 stars 71 forks source link

Description of the changes

Allow key label / id to be defaulted from the corresponding cert settings and vice-versa. Most PKCS#11 token layouts follow a reasonable naming scheme where for a given key <> cert pair, either the IDs or the labels coincide, so this allows for better ergonomics there.
For directly instantiated PKCS11Signer s, delay throwing errors until key/cert lookup (allows even more flexibility at the cost of slightly less informative error messages at this level of the API)

Fixes #386

Caveats

There is a minor change in exception behaviour inside PKCS11Signer, since the __init__ method no longer does any validation.

Checklist

Please go over this checklist to increase the chances of your PR being worked on in a timely manner. Deviations are allowed with proper justification (see previous section).

[x] I have read the project's CoC and contribution guidelines.
[x] I understand and agree to the terms in the Developer Certificate of Origin as applied to this contribution.
[x] All new code in this PR has full test coverage.

For new features (delete if not applicable)

[x] I have discussed the implementation of this feature with the project maintainer(s) on the discussion forum or over email.
[x] I have verified that my changes do not break existing API or CLI functionality, or ensured that all breaking changes are clearly documented in this PR.
[x] All public API functionality in this PR is documented.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.83%. Comparing base (9936d8c) to head (99ab3b4).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #387 +/- ## ======================================= Coverage 98.83% 98.83% ======================================= Files 113 113 Lines 16291 16299 +8 ======================================= + Hits 16101 16109 +8 Misses 190 190 ``` | [Flag](https://app.codecov.io/gh/MatthiasValvekens/pyHanko/pull/387/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Matthias+Valvekens) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MatthiasValvekens/pyHanko/pull/387/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Matthias+Valvekens) | `98.83% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Matthias+Valvekens#carryforward-flags-in-the-pull-request-comment) to find out more.

MatthiasValvekens / pyHanko