diff options
author | Dr. Stephen Henson <steve@openssl.org> | 2006-07-09 11:01:49 +0000 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2006-07-09 11:01:49 +0000 |
commit | 7441052be614f1be629d7e5543baafbe6deea32f (patch) | |
tree | 95e2a82b485e0d5bfd3ffb3eac90bde306858d4f /doc | |
parent | 90ccf05f8276a6e289d8b49002d7ed470bf5d517 (diff) |
EVP_PKEY_get_default_digest() manual page.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/crypto/EVP_PKEY_get_default_digest.pod | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/crypto/EVP_PKEY_get_default_digest.pod b/doc/crypto/EVP_PKEY_get_default_digest.pod new file mode 100644 index 0000000000..700a04c178 --- /dev/null +++ b/doc/crypto/EVP_PKEY_get_default_digest.pod @@ -0,0 +1,41 @@ +=pod + +=head1 NAME + +EVP_PKEY_get_default_digest_nid - get default signature digest + +=head1 SYNOPSIS + + #include <openssl/evp.h> + int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid); + +=head1 DESCRIPTION + +The EVP_PKEY_get_default_digest_nid() function sets B<pnid> to the default +message digest NID for the public key signature operations associated with key +B<pkey>. + +=head1 NOTES + +For all current standard OpenSSL public key algorithms SHA1 is returned. + +=head1 RETURN VALUES + +The EVP_PKEY_get_default_digest_nid() function returns 1 if the message digest +is advisory (that is other digests can be used) and 2 if it is mandatory (other +digests can not be used). It returns 0 or a negative value for failure. In +particular a return value of -2 indicates the operation is not supported by the +public key algorithm. + +=head1 SEE ALSO + +L<EVP_PKEY_CTX_new(3)|EVP_PKEY_CTX_new(3)>, +L<EVP_PKEY_sign(3)|EVP_PKEY_sign(3)>, +L<EVP_PKEY_verify(3)|EVP_PKEY_verify(3)>, +L<EVP_PKEY_verifyrecover(3)|EVP_PKEY_verifyrecover(3)>, + +=head1 HISTORY + +This function was first added to OpenSSL 0.9.9. + +=cut |