lib/libcrypto/man/EVP_PKEY_print_private.3

   1 .\"     $OpenBSD: EVP_PKEY_print_private.3,v 1.4 2016/11/27 15:27:19 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) 2006, 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: November 27 2016 $
  52 .Dt EVP_PKEY_PRINT_PRIVATE 3
  53 .Os
  54 .Sh NAME
  55 .Nm EVP_PKEY_print_public ,
  56 .Nm EVP_PKEY_print_private ,
  57 .Nm EVP_PKEY_print_params
  58 .Nd public key algorithm printing routines
  59 .Sh SYNOPSIS
  60 .In openssl/evp.h
  61 .Ft int
  62 .Fo EVP_PKEY_print_public
  63 .Fa "BIO *out"
  64 .Fa "const EVP_PKEY *pkey"
  65 .Fa "int indent"
  66 .Fa "ASN1_PCTX *pctx"
  67 .Fc
  68 .Ft int
  69 .Fo EVP_PKEY_print_private
  70 .Fa "BIO *out"
  71 .Fa "const EVP_PKEY *pkey"
  72 .Fa "int indent"
  73 .Fa "ASN1_PCTX *pctx"
  74 .Fc
  75 .Ft int
  76 .Fo EVP_PKEY_print_params
  77 .Fa "BIO *out"
  78 .Fa "const EVP_PKEY *pkey"
  79 .Fa "int indent"
  80 .Fa "ASN1_PCTX *pctx"
  81 .Fc
  82 .Sh DESCRIPTION
  83 The functions
  84 .Fn EVP_PKEY_print_public ,
  85 .Fn EVP_PKEY_print_private ,
  86 and
  87 .Fn EVP_PKEY_print_params
  88 print out the public, private or parameter components of key
  89 .Fa pkey ,
  90 respectively.
  91 The key is sent to
  92 .Vt BIO
  93 .Fa out
  94 in human readable form.
  95 The parameter
  96 .Fa indent
  97 indicates how far the printout should be indented.
  98 .Pp
  99 The
 100 .Fa pctx
 101 parameter allows the print output to be finely tuned by using ASN.1
 102 printing options.
 103 If
 104 .Fa pctx
 105 is set to
 106 .Dv NULL ,
 107 then default values will be used.
 108 Currently, no public key algorithms include any options in the
 109 .Fa pctx
 110 parameter.
 111 .Pp
 112 If the key does not include all the components indicated by the function,
 113 then only those contained in the key will be printed.
 114 For example, passing a public key to
 115 .Fn EVP_PKEY_print_private
 116 will only print the public components.
 117 .Sh RETURN VALUES
 118 These functions all return 1 for success and 0 or a negative value for
 119 failure.
 120 In particular, a return value of -2 indicates the operation is not
 121 supported by the public key algorithm.
 122 .Sh SEE ALSO
 123 .Xr EVP_PKEY_CTX_new 3 ,
 124 .Xr EVP_PKEY_keygen 3
 125 .Sh HISTORY
 126 These functions were first added to OpenSSL 1.0.0.