lib/libcrypto/man/PKCS8_PRIV_KEY_INFO_new.3

   1 .\"     $OpenBSD: PKCS8_PRIV_KEY_INFO_new.3,v 1.2 2016/12/25 22:15:10 schwarze Exp $
   2 .\"
   3 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: December 25 2016 $
  18 .Dt PKCS8_PRIV_KEY_INFO_NEW 3
  19 .Os
  20 .Sh NAME
  21 .Nm PKCS8_PRIV_KEY_INFO_new ,
  22 .Nm PKCS8_PRIV_KEY_INFO_free
  23 .Nd PKCS#8 private key information
  24 .Sh SYNOPSIS
  25 .In openssl/x509.h
  26 .Ft PKCS8_PRIV_KEY_INFO *
  27 .Fn PKCS8_PRIV_KEY_INFO_new void
  28 .Ft void
  29 .Fn PKCS8_PRIV_KEY_INFO_free "PKCS8_PRIV_KEY_INFO *key"
  30 .Sh DESCRIPTION
  31 .Fn PKCS8_PRIV_KEY_INFO_new
  32 allocates and initializes an empty
  33 .Vt PKCS8_PRIV_KEY_INFO
  34 object, representing an ASN.1
  35 .Vt PrivateKeyInfo
  36 structure defined in RFC 5208 section 5.
  37 It can hold a private key together with information about the
  38 algorithm to be used with it and optional attributes.
  39 .Pp
  40 .Fn PKCS8_PRIV_KEY_INFO_free
  41 frees
  42 .Fa key .
  43 .Sh RETURN VALUES
  44 .Fn PKCS8_PRIV_KEY_INFO_new
  45 returns the new
  46 .Vt PKCS8_PRIV_KEY_INFO
  47 object or
  48 .Dv NULL
  49 if an error occurs.
  50 .Sh SEE ALSO
  51 .Xr d2i_PKCS8PrivateKey_bio 3 ,
  52 .Xr PEM_read_PKCS8_PRIV_KEY_INFO 3 ,
  53 .Xr PKCS12_parse 3 ,
  54 .Xr X509_ATTRIBUTE_new 3
  55 .Sh STANDARDS
  56 RFC 5208: PKCS#8: Private-Key Information Syntax Specification