[gnutls-devel] GnuTLS | p11tool manpage is not in line with 'PKCS #11 URI Matching Guidelines' (#1680)

[Read-only notification of GnuTLS library development activities]

Zoltán Fridrich created an issue: https://gitlab.com/gnutls/gnutls/-/issues/1680



p11tool manpage is written in a way that implies that only one Token is specified by URL, however, PKCS #11 URI allows matching rules (see https://datatracker.ietf.org/doc/html/rfc7512#section-2.5) that allows one URI to match multiple tokens. This should be reflected in p11tool manpage. Incorrect wording is present in multiple sections of manpage and whole manpage should be reviewed. Couple of picked examples and suggested improvements are below.

Version-Release number of selected component (if applicable):
gnutls-utils-3.6.14-7.el8_3.x86_64

Actual state:
1) Object listing
--list-all
List all available objects in a token.
All objects available in the token will be listed.

2) Key generation
--generate-privkey=string
Generate private-public key pair of given type.
Generates a private-public key pair in the specified token.

Suggested improvement:
1a) Object listing
--list-all
List all available objects.
All available objects will be listed.
1b) Object listing
--list-all
List all available objects in a tokens matching specified URI.
All objects available in the tokens matching URI will be listed.

2) Key generation
--generate-privkey=string
Generate private-public key pair of given type.
Generates a private-public key pair in the specified token. Provided URI must match single token.

Additional info:
In SYNOPSIS or DESCRIPTION section of manpage, it could be clarified that URI may match multiple tokens and for some operation URI matching single token should be provided. Sentence saying something like "For more details about URIs and matching rules see The PKCS #11 URI Scheme" could be added.

-- 
Reply to this email directly or view it on GitLab: https://gitlab.com/gnutls/gnutls/-/issues/1680
You're receiving this email because of your account on gitlab.com.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.gnupg.org/pipermail/gnutls-devel/attachments/20250311/85a1e137/attachment.html>