lib/libcrypto/man/d2i_DHparams.3

   1 .\" $OpenBSD: d2i_DHparams.3,v 1.7 2018/03/20 22:22:10 schwarze Exp $
   2 .\" full merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org> and
   5 .\" Dr. Stephen Henson <steve@openssl.org>.
   6 .\" Copyright (c) 2000, 2002, 2015, 2017 The OpenSSL Project.
   7 .\" All rights reserved.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\"
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\"
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in
  18 .\"    the documentation and/or other materials provided with the
  19 .\"    distribution.
  20 .\"
  21 .\" 3. All advertising materials mentioning features or use of this
  22 .\"    software must display the following acknowledgment:
  23 .\"    "This product includes software developed by the OpenSSL Project
  24 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  25 .\"
  26 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27 .\"    endorse or promote products derived from this software without
  28 .\"    prior written permission. For written permission, please contact
  29 .\"    openssl-core@openssl.org.
  30 .\"
  31 .\" 5. Products derived from this software may not be called "OpenSSL"
  32 .\"    nor may "OpenSSL" appear in their names without prior written
  33 .\"    permission of the OpenSSL Project.
  34 .\"
  35 .\" 6. Redistributions of any form whatsoever must retain the following
  36 .\"    acknowledgment:
  37 .\"    "This product includes software developed by the OpenSSL Project
  38 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  52 .\"
  53 .Dd $Mdocdate: March 20 2018 $
  54 .Dt D2I_DHPARAMS 3
  55 .Os
  56 .Sh NAME
  57 .Nm d2i_DHparams ,
  58 .Nm i2d_DHparams
  59 .Nd PKCS#3 DH parameter functions
  60 .Sh SYNOPSIS
  61 .In openssl/dh.h
  62 .Ft DH *
  63 .Fo d2i_DHparams
  64 .Fa "DH **a"
  65 .Fa "unsigned char **pp"
  66 .Fa "long length"
  67 .Fc
  68 .Ft int
  69 .Fo i2d_DHparams
  70 .Fa "DH *a"
  71 .Fa "unsigned char **pp"
  72 .Fc
  73 .Sh DESCRIPTION
  74 These functions decode and encode PKCS#3 DH parameters using the
  75 DHparameter structure described in PKCS#3.
  76 They otherwise behave in a way similar to
  77 .Xr d2i_X509 3
  78 and
  79 .Xr i2d_X509 3 .
  80 .Sh RETURN VALUES
  81 .Fn d2i_DHparams
  82 returns a
  83 .Vt DH
  84 object or
  85 .Dv NULL
  86 if an error occurs.
  87 .Pp
  88 .Fn i2d_DHparams
  89 returns the number of bytes successfully encoded or a value <= 0
  90 if an error occurs.
  91 .Sh SEE ALSO
  92 .Xr d2i_X509 3 ,
  93 .Xr DH_new 3
  94 .Sh HISTORY
  95 .Fn d2i_DHparams
  96 and
  97 .Fn i2d_DHparams
  98 appeared in SSLeay 0.8.1b or earlier and have been available since
  99 .Ox 2.4 .