lib/libcrypto/man/PKCS12_parse.3

   1 .\"     $OpenBSD: PKCS12_parse.3,v 1.5 2018/03/21 17:57:48 schwarze Exp $
   2 .\"     OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
   3 .\"
   4 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
   5 .\" Copyright (c) 2002, 2009 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 21 2018 $
  52 .Dt PKCS12_PARSE 3
  53 .Os
  54 .Sh NAME
  55 .Nm PKCS12_parse
  56 .Nd parse a PKCS#12 structure
  57 .Sh SYNOPSIS
  58 .In openssl/pkcs12.h
  59 .Ft int
  60 .Fo PKCS12_parse
  61 .Fa "PKCS12 *p12"
  62 .Fa "const char *pass"
  63 .Fa "EVP_PKEY **pkey"
  64 .Fa "X509 **cert"
  65 .Fa "STACK_OF(X509) **ca"
  66 .Fc
  67 .Sh DESCRIPTION
  68 .Fn PKCS12_parse
  69 parses a PKCS12 structure.
  70 .Pp
  71 .Fa p12
  72 is the
  73 .Vt PKCS12
  74 structure to parse.
  75 .Fa pass
  76 is the passphrase to use.
  77 If successful, the private key will be written to
  78 .Pf * Fa pkey ,
  79 the corresponding certificate to
  80 .Pf * Fa cert ,
  81 and any additional certificates to
  82 .Pf * Fa ca .
  83 .Pp
  84 The parameters
  85 .Fa pkey
  86 and
  87 .Fa cert
  88 cannot be
  89 .Dv NULL .
  90 .Fa ca
  91 can be
  92 .Dv NULL ,
  93 in which case additional certificates will be discarded.
  94 .Pf * Fa ca
  95 can also be a valid STACK, in which case additional certificates are
  96 appended to
  97 .Pf * Fa ca .
  98 If
  99 .Pf * Fa ca
 100 is
 101 .Dv NULL ,
 102 a new STACK will be allocated.
 103 .Pp
 104 The
 105 .Sy friendlyName
 106 and
 107 .Sy localKeyID
 108 attributes (if present) of each certificate will be stored in the
 109 .Fa alias
 110 and
 111 .Fa keyid
 112 attributes of the
 113 .Vt X509
 114 structure.
 115 .Sh RETURN VALUES
 116 .Fn PKCS12_parse
 117 returns 1 for success and 0 if an error occurred.
 118 .Pp
 119 The error can be obtained from
 120 .Xr ERR_get_error 3 .
 121 .Sh SEE ALSO
 122 .Xr d2i_PKCS12 3
 123 .Sh HISTORY
 124 .Fn PKCS12_parse
 125 first appeared in OpenSSL 0.9.3 and has been available since
 126 .Ox 2.6 .
 127 .Sh BUGS
 128 Only a single private key and corresponding certificate is returned by
 129 this function.
 130 More complex PKCS#12 files with multiple private keys will only return
 131 the first match.
 132 .Pp
 133 Only
 134 .Sy friendlyName
 135 and
 136 .Sy localKeyID
 137 attributes are currently stored in certificates.
 138 Other attributes are discarded.
 139 .Pp
 140 Attributes currently cannot be stored in the private key
 141 .Vt EVP_PKEY
 142 structure.