summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EVP_PKEY_get_default_digest.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/EVP_PKEY_get_default_digest.3')
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_get_default_digest.339
1 files changed, 39 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_get_default_digest.3 b/src/lib/libcrypto/man/EVP_PKEY_get_default_digest.3
new file mode 100644
index 0000000000..2266adadf3
--- /dev/null
+++ b/src/lib/libcrypto/man/EVP_PKEY_get_default_digest.3
@@ -0,0 +1,39 @@
1.Dd $Mdocdate: November 3 2016 $
2.Dt EVP_PKEY_GET_DEFAULT_DIGEST 3
3.Os
4.Sh NAME
5.Nm EVP_PKEY_get_default_digest_nid
6.Nd get default signature digest
7.Sh SYNOPSIS
8.In openssl/evp.h
9.Ft int
10.Fo EVP_PKEY_get_default_digest_nid
11.Fa "EVP_PKEY *pkey"
12.Fa "int *pnid"
13.Fc
14.Sh DESCRIPTION
15The
16.Fn EVP_PKEY_get_default_digest_nid
17function sets
18.Fa pnid
19to the default message digest NID for the public key signature
20operations associated with key
21.Fa pkey .
22.Pp
23For all current standard OpenSSL public key algorithms, SHA1 is returned.
24.Sh RETURN VALUES
25The
26.Fn EVP_PKEY_get_default_digest_nid
27function returns 1 if the message digest is advisory (that is other
28digests can be used) and 2 if it is mandatory (other digests cannot be
29used).
30It returns 0 or a negative value for failure.
31In particular, a return value of -2 indicates the operation is not
32supported by the public key algorithm.
33.Sh SEE ALSO
34.Xr EVP_PKEY_CTX_new 3 ,
35.Xr EVP_PKEY_sign 3 ,
36.Xr EVP_PKEY_verify 3 ,
37.Xr EVP_PKEY_verify_recover 3
38.Sh HISTORY
39This function was first added to OpenSSL 1.0.0.