doc/man3/EVP_PKEY_get_default_digest_nid.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_get_default_digest_nid - get default signature digest
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/evp.h>
  10  int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid);
  11
  12 =head1 DESCRIPTION
  13
  14 The EVP_PKEY_get_default_digest_nid() function sets B<pnid> to the default
  15 message digest NID for the public key signature operations associated with key
  16 B<pkey>.
  17
  18 =head1 NOTES
  19
  20 For all current standard OpenSSL public key algorithms SHA1 is returned.
  21
  22 =head1 RETURN VALUES
  23
  24 The EVP_PKEY_get_default_digest_nid() function returns 1 if the message digest
  25 is advisory (that is other digests can be used) and 2 if it is mandatory (other
  26 digests can not be used).  It returns 0 or a negative value for failure. In
  27 particular a return value of -2 indicates the operation is not supported by the
  28 public key algorithm.
  29
  30 =head1 SEE ALSO
  31
  32 L<EVP_PKEY_CTX_new(3)>,
  33 L<EVP_PKEY_sign(3)>,
  34 L<EVP_PKEY_verify(3)>,
  35 L<EVP_PKEY_verify_recover(3)>,
  36
  37 =head1 HISTORY
  38
  39 This function was first added to OpenSSL 1.0.0.
  40
  41 =head1 COPYRIGHT
  42
  43 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  44
  45 Licensed under the OpenSSL license (the "License").  You may not use
  46 this file except in compliance with the License.  You can obtain a copy
  47 in the file LICENSE in the source distribution or at
  48 L<https://www.openssl.org/source/license.html>.
  49
  50 =cut