Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_get_group_name.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_GROUP_NAME 3SSL"
58 .TH EVP_PKEY_GET_GROUP_NAME 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_group_name \- get group name of a key
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/evp.h>
69 \&
70 \& int EVP_PKEY_get_group_name(EVP_PKEY *pkey, char *gname, size_t gname_sz,
71 \& size_t *gname_len);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBEVP_PKEY_get_group_name()\fR fills in the group name of the \fIpkey\fR into
76 \&\fIgname\fR, up to at most \fIgname_sz\fR bytes including the ending NUL byte
77 and assigns \fI*gname_len\fR the actual length of the name not including
78 the NUL byte, if \fIpkey\fR's key type supports it.
79 \&\fIgname\fR as well as \fIgname_len\fR may individually be NULL, and won't be
80 filled in or assigned in that case.
81 .SH NOTES
82 .IX Header "NOTES"
83 Among the standard OpenSSL key types, this is only supported for DH, EC and
84 SM2 keys. Other providers may support this for additional key types.
85 .SH "RETURN VALUES"
86 .IX Header "RETURN VALUES"
87 \&\fBEVP_PKEY_get_group_name()\fR returns 1 if the group name could be filled in,
88 otherwise 0.
89 .SH HISTORY
90 .IX Header "HISTORY"
91 This function was added in OpenSSL 3.0.
92 .SH COPYRIGHT
93 .IX Header "COPYRIGHT"
94 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
95 .PP
96 Licensed under the Apache License 2.0 (the "License"). You may not use
97 this file except in compliance with the License. You can obtain a copy
98 in the file LICENSE in the source distribution or at
99 <https://www.openssl.org/source/license.html>.