Blame doc/man3/EVP_PKEY_get_default_digest_nid.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
EVP_PKEY_get_default_digest_nid - get default signature digest
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/evp.h>
Packit Service 084de1
 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
The EVP_PKEY_get_default_digest_nid() function sets B<pnid> to the default
Packit Service 084de1
message digest NID for the public key signature operations associated with key
Packit Service 084de1
B<pkey>. Note that some signature algorithms (i.e. Ed25519 and Ed448) do not use
Packit Service 084de1
a digest during signing. In this case B<pnid> will be set to NID_undef.
Packit Service 084de1
Packit Service 084de1
=head1 NOTES
Packit Service 084de1
Packit Service 084de1
For all current standard OpenSSL public key algorithms SHA1 is returned.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
The EVP_PKEY_get_default_digest_nid() function returns 1 if the message digest
Packit Service 084de1
is advisory (that is other digests can be used) and 2 if it is mandatory (other
Packit Service 084de1
digests can not be used).  It returns 0 or a negative value for failure. In
Packit Service 084de1
particular a return value of -2 indicates the operation is not supported by the
Packit Service 084de1
public key algorithm.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<EVP_PKEY_CTX_new(3)>,
Packit Service 084de1
L<EVP_PKEY_sign(3)>,
Packit Service 084de1
L<EVP_PKEY_verify(3)>,
Packit Service 084de1
L<EVP_PKEY_verify_recover(3)>,
Packit Service 084de1
Packit Service 084de1
=head1 HISTORY
Packit Service 084de1
Packit Service 084de1
This function was added in OpenSSL 1.0.0.
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut