Skip to content

Commit

Permalink
DOCS: provider-keymgmt(7) - params for EVP_PKEY_get_default_digest_{n…
Browse files Browse the repository at this point in the history
…ame,nid}()

This describes them in detail in provider-keymgmt(7).

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from #20430)
  • Loading branch information
levitte committed Mar 7, 2023
1 parent bf762f9 commit ac57336
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doc/man7/EVP_PKEY-EC.pod
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
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

0 comments on commit ac57336

Please sign in to comment.