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.

Sign up for GitHub

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

Jump to bottom

DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params description #20430

Closed
wants to merge 4 commits into from
Closed

DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params description #20430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33cdc8e
DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params description
levitte Mar 3, 2023
486993a
squash! DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params d…
levitte Mar 3, 2023
9d85db9
fixup! DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params de…
levitte Mar 3, 2023
2d7cdcc
fixup! DOCS: EVP_PKEY_get_default_digest_{name,nid}() - add params de…
levitte Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/man7/EVP_PKEY-EC.pod
View file
Open in desktop
Expand Up @@ -142,7 +142,7 @@ Used for getting the EC public key X component.

Used for getting the EC public key Y component.

=item (B<OSSL_PKEY_PARAM_DEFAULT_DIGEST>) <UTF8 string>
=item "default-digest" (B<OSSL_PKEY_PARAM_DEFAULT_DIGEST>) <UTF8 string>

Getter that returns the default digest name.
(Currently returns "SHA256" as of OpenSSL 3.0).
Expand Down
30 changes: 30 additions & 0 deletions doc/man7/provider-keymgmt.pod
View file
Open in desktop
Expand Up @@ -390,6 +390,36 @@ dimensions handled in the rest of the same provider.
The value should be the number of security bits of the given key.
Bits of security is defined in SP800-57.

=item "mandatory-digest" (B<OSSL_PKEY_PARAM_MANDATORY_DIGEST>) <UTF8 string>

If there is a mandatory digest for performing a signature operation with
keys from this keymgmt, this parameter should get its name as value.

When EVP_PKEY_get_default_digest_name() queries this parameter and it's
filled in by the implementation, its return value will be 2.

If the keymgmt implementation fills in the value C<""> or C<"UNDEF">,
L<EVP_PKEY_get_default_digest_name(3)> will place the string C<"UNDEF"> into
its argument I<mdname>. This signifies that no digest should be specified
with the corresponding signature operation.

=item "default-digest" (B<OSSL_PKEY_PARAM_DEFAULT_DIGEST>) <UTF8 string>

If there is a default digest for performing a signature operation with
keys from this keymgmt, this parameter should get its name as value.

When L<EVP_PKEY_get_default_digest_name(3)> queries this parameter and it's
filled in by the implementation, its return value will be 1. Note that if
B<OSSL_PKEY_PARAM_MANDATORY_DIGEST> is responded to as well,
L<EVP_PKEY_get_default_digest_name(3)> ignores the response to this
parameter.

If the keymgmt implementation fills in the value C<""> or C<"UNDEF">,
L<EVP_PKEY_get_default_digest_name(3)> will place the string C<"UNDEF"> into
its argument I<mdname>. This signifies that no digest has to be specified
with the corresponding signature operation, but may be specified as an
option.

=back

=head1 RETURN VALUES
Expand Down