Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: PKCS12_parse.3,v 1.26 2025/04/16 15:23:16 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..

..


..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "PKCS12_parse 3" 
 PKCS12_parse 3 2025-02-11 3.0.16 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 NAME
PKCS12_parse - parse a PKCS#12 structure

 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/pkcs12.h>
\&
 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
  STACK_OF(X509) **ca);
.Ve

 DESCRIPTION
 Header "DESCRIPTION" \fBPKCS12_parse() parses a PKCS12 structure.


\fBp12 is the PKCS12 structure to parse. pass is the passphrase to use.
If successful the private key will be written to *pkey, the corresponding
certificate to *cert and any additional certificates to *ca.

 NOTES
 Header "NOTES" Each of the parameters pkey, cert, and ca can be NULL in which case
the private key, the corresponding certificate, or the additional certificates,
respectively, will be discarded.
If any of pkey and cert is non-NULL the variable it points to is
initialized.
If ca is non-NULL and *ca is NULL a new STACK will be allocated.
If ca is non-NULL and *ca is a valid STACK
then additional certificates are appended in the given order to *ca.


The friendlyName and localKeyID attributes (if present) on each
certificate will be stored in the alias and keyid attributes of the
\fBX509 structure.


The parameter pass is interpreted as a string in the UTF-8 encoding. If it
is not valid UTF-8, then it is assumed to be ISO8859-1 instead.


In particular, this means that passwords in the locale character set
(or code page on Windows) must potentially be converted to UTF-8 before
use. This may include passwords from local text files, or input from
the terminal or command line. Refer to the documentation of
\fBUI_OpenSSL\|(3), for example.

 "RETURN VALUES"
 Header "RETURN VALUES" \fBPKCS12_parse() returns 1 for success and zero if an error occurred.


The error can be obtained from ERR_get_error\|(3)

 BUGS
 Header "BUGS" Only a single private key and corresponding certificate is returned by this
function. More complex PKCS#12 files with multiple private keys will only
return the first match.


Only friendlyName and localKeyID attributes are currently stored in
certificates. Other attributes are discarded.


Attributes currently cannot be stored in the private key EVP_PKEY structure.

 "SEE ALSO"
 Header "SEE ALSO" \fBd2i_PKCS12\|(3),
\fBpassphrase-encoding\|(7)

 COPYRIGHT
 Header "COPYRIGHT" Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.


Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.