xref: /freebsd-src/crypto/openssl/doc/man3/PKCS12_get_friendlyname.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryPKCS12_get_friendlyname - Retrieve the friendlyname attribute from a PKCS#12 safeBag
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 SYNOPSIS
8*b077aed3SPierre Pronchery
9*b077aed3SPierre Pronchery #include <openssl/pkcs12.h>
10*b077aed3SPierre Pronchery
11*b077aed3SPierre Pronchery char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=head1 DESCRIPTION
14*b077aed3SPierre Pronchery
15*b077aed3SPierre ProncheryPKCS12_get_friendlyname() retrieves a UTF-8 string representation of the PKCS#9
16*b077aed3SPierre ProncheryfriendlyName attribute for a PKCS#12 safeBag item.
17*b077aed3SPierre Pronchery
18*b077aed3SPierre ProncheryI<bag> is the B<PKCS12_SAFEBAG> to retrieve the attribute from.
19*b077aed3SPierre Pronchery
20*b077aed3SPierre Pronchery=head1 RETURN VALUES
21*b077aed3SPierre Pronchery
22*b077aed3SPierre ProncheryA UTF-8 string, or NULL if the attribute was either not present or an error occurred.
23*b077aed3SPierre Pronchery
24*b077aed3SPierre ProncheryThe returned string is allocated by OpenSSL and should be freed by the user.
25*b077aed3SPierre Pronchery
26*b077aed3SPierre Pronchery=head1 SEE ALSO
27*b077aed3SPierre Pronchery
28*b077aed3SPierre ProncheryL<PKCS12_add_friendlyname_asc(3)>
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=head1 COPYRIGHT
31*b077aed3SPierre Pronchery
32*b077aed3SPierre ProncheryCopyright 2019 The OpenSSL Project Authors. All Rights Reserved.
33*b077aed3SPierre Pronchery
34*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
35*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
36*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
37*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
38*b077aed3SPierre Pronchery
39*b077aed3SPierre Pronchery=cut
40