lib/libcrypto/man/RSA_print.3

   1 .\"     $OpenBSD: RSA_print.3,v 1.7 2018/03/20 22:22:10 schwarze Exp $
   2 .\"     OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org>.
   5 .\" Copyright (c) 2000, 2002, 2003 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 20 2018 $
  52 .Dt RSA_PRINT 3
  53 .Os
  54 .Sh NAME
  55 .Nm RSA_print ,
  56 .Nm RSA_print_fp ,
  57 .Nm DSAparams_print ,
  58 .Nm DSAparams_print_fp ,
  59 .Nm DSA_print ,
  60 .Nm DSA_print_fp ,
  61 .Nm DHparams_print ,
  62 .Nm DHparams_print_fp
  63 .Nd print cryptographic parameters
  64 .Sh SYNOPSIS
  65 .In openssl/rsa.h
  66 .Ft int
  67 .Fo RSA_print
  68 .Fa "BIO *bp"
  69 .Fa "RSA *x"
  70 .Fa "int offset"
  71 .Fc
  72 .Ft int
  73 .Fo RSA_print_fp
  74 .Fa "FILE *fp"
  75 .Fa "RSA *x"
  76 .Fa "int offset"
  77 .Fc
  78 .In openssl/dsa.h
  79 .Ft int
  80 .Fo DSAparams_print
  81 .Fa "BIO *bp"
  82 .Fa "DSA *x"
  83 .Fc
  84 .Ft int
  85 .Fo DSAparams_print_fp
  86 .Fa "FILE *fp"
  87 .Fa "DSA *x"
  88 .Fc
  89 .Ft int
  90 .Fo DSA_print
  91 .Fa "BIO *bp"
  92 .Fa "DSA *x"
  93 .Fa "int offset"
  94 .Fc
  95 .Ft int
  96 .Fo DSA_print_fp
  97 .Fa "FILE *fp"
  98 .Fa "DSA *x"
  99 .Fa "int offset"
 100 .Fc
 101 .In openssl/dh.h
 102 .Ft int
 103 .Fo DHparams_print
 104 .Fa "BIO *bp"
 105 .Fa "DH *x"
 106 .Fc
 107 .Ft int
 108 .Fo DHparams_print_fp
 109 .Fa "FILE *fp"
 110 .Fa "DH *x"
 111 .Fc
 112 .Sh DESCRIPTION
 113 A human-readable hexadecimal output of the components of the RSA key,
 114 DSA parameters or key or DH parameters is printed to
 115 .Fa bp
 116 or
 117 .Fa fp .
 118 .Pp
 119 The output lines are indented by
 120 .Fa offset
 121 spaces.
 122 .Sh RETURN VALUES
 123 These functions return 1 on success or 0 on error.
 124 .Sh SEE ALSO
 125 .Xr BN_bn2bin 3 ,
 126 .Xr DH_get0_pqg 3 ,
 127 .Xr DSA_get0_pqg 3 ,
 128 .Xr RSA_get0_key 3 ,
 129 .Xr RSA_new 3
 130 .Sh HISTORY
 131 .Fn RSA_print ,
 132 .Fn RSA_print_fp ,
 133 .Fn DSA_print ,
 134 .Fn DSA_print_fp ,
 135 .Fn DHparams_print ,
 136 and
 137 .Fn DHparams_print_fp
 138 appeared before SSLeay 0.8.
 139 .Fn DSAparams_print
 140 and
 141 .Fn DSAparams_print_fp
 142 first appeared in SSLeay 0.8.
 143 All these functions have been available since
 144 .Ox 2.4 .