Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_get_default_digest_nid.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_PKEY_GET_DEFAULT_DIGEST_NID 3SSL"
58 .TH EVP_PKEY_GET_DEFAULT_DIGEST_NID 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_PKEY_get_default_digest_nid, EVP_PKEY_get_default_digest_name
65 \&\- get default signature digest
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/evp.h>
70 \&
71 \& int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
72 \& char *mdname, size_t mdname_sz);
73 \& int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBEVP_PKEY_get_default_digest_name()\fR fills in the default message digest
78 name for the public key signature operations associated with key
79 \&\fIpkey\fR into \fImdname\fR, up to at most \fImdname_sz\fR bytes including the
80 ending NUL byte. The name could be \f(CW"UNDEF"\fR, signifying that a digest
81 must (for return value 2) or may (for return value 1) be left unspecified.
82 .PP
83 \&\fBEVP_PKEY_get_default_digest_nid()\fR sets \fIpnid\fR to the default message
84 digest NID for the public key signature operations associated with key
85 \&\fIpkey\fR. Note that some signature algorithms (i.e. Ed25519 and Ed448)
86 do not use a digest during signing. In this case \fIpnid\fR will be set
87 to NID_undef. This function is only reliable for legacy keys, which
88 are keys with a \fBEVP_PKEY_ASN1_METHOD\fR; these keys have typically
89 been loaded from engines, or created with \fBEVP_PKEY_assign_RSA\fR\|(3) or
90 similar.
91 .SH NOTES
92 .IX Header "NOTES"
93 For all current standard OpenSSL public key algorithms SHA256 is returned.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 \&\fBEVP_PKEY_get_default_digest_name()\fR and \fBEVP_PKEY_get_default_digest_nid()\fR
97 both return 1 if the message digest is advisory (that is other digests
98 can be used) and 2 if it is mandatory (other digests can not be used).
99 They return 0 or a negative value for failure. In particular a return
100 value of \-2 indicates the operation is not supported by the public key
101 algorithm.
102 .SH "SEE ALSO"
103 .IX Header "SEE ALSO"
104 \&\fBEVP_PKEY_CTX_new\fR\|(3),
105 \&\fBEVP_PKEY_sign\fR\|(3),
106 \&\fBEVP_PKEY_digestsign_supports_digest\fR\|(3),
107 \&\fBEVP_PKEY_verify\fR\|(3),
108 \&\fBEVP_PKEY_verify_recover\fR\|(3),
109 .SH HISTORY
110 .IX Header "HISTORY"
111 This function was added in OpenSSL 1.0.0.
112 .SH COPYRIGHT
113 .IX Header "COPYRIGHT"
114 Copyright 2006\-2023 The OpenSSL Project Authors. All Rights Reserved.
115 .PP
116 Licensed under the Apache License 2.0 (the "License"). You may not use
117 this file except in compliance with the License. You can obtain a copy
118 in the file LICENSE in the source distribution or at
119 <https://www.openssl.org/source/license.html>.