99 lines
3.4 KiB
Groff
99 lines
3.4 KiB
Groff
.\" $OpenBSD: d2i_DHparams.3,v 1.8 2018/03/27 17:35:50 schwarze Exp $
|
|
.\" full merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800
|
|
.\"
|
|
.\" This file was written by Ulf Moeller <ulf@openssl.org> and
|
|
.\" Dr. Stephen Henson <steve@openssl.org>.
|
|
.\" Copyright (c) 2000, 2002, 2015, 2017 The OpenSSL Project.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\"
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\"
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in
|
|
.\" the documentation and/or other materials provided with the
|
|
.\" distribution.
|
|
.\"
|
|
.\" 3. All advertising materials mentioning features or use of this
|
|
.\" software must display the following acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
|
|
.\"
|
|
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
|
|
.\" endorse or promote products derived from this software without
|
|
.\" prior written permission. For written permission, please contact
|
|
.\" openssl-core@openssl.org.
|
|
.\"
|
|
.\" 5. Products derived from this software may not be called "OpenSSL"
|
|
.\" nor may "OpenSSL" appear in their names without prior written
|
|
.\" permission of the OpenSSL Project.
|
|
.\"
|
|
.\" 6. Redistributions of any form whatsoever must retain the following
|
|
.\" acknowledgment:
|
|
.\" "This product includes software developed by the OpenSSL Project
|
|
.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
|
|
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
|
|
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd $Mdocdate: March 27 2018 $
|
|
.Dt D2I_DHPARAMS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm d2i_DHparams ,
|
|
.Nm i2d_DHparams
|
|
.Nd PKCS#3 DH parameter functions
|
|
.Sh SYNOPSIS
|
|
.In openssl/dh.h
|
|
.Ft DH *
|
|
.Fo d2i_DHparams
|
|
.Fa "DH **a"
|
|
.Fa "unsigned char **pp"
|
|
.Fa "long length"
|
|
.Fc
|
|
.Ft int
|
|
.Fo i2d_DHparams
|
|
.Fa "DH *a"
|
|
.Fa "unsigned char **pp"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
These functions decode and encode PKCS#3 DH parameters using the
|
|
DHparameter structure described in PKCS#3.
|
|
They otherwise behave in a way similar to
|
|
.Xr d2i_X509 3
|
|
and
|
|
.Xr i2d_X509 3 .
|
|
.Sh RETURN VALUES
|
|
.Fn d2i_DHparams
|
|
returns a
|
|
.Vt DH
|
|
object or
|
|
.Dv NULL
|
|
if an error occurs.
|
|
.Pp
|
|
.Fn i2d_DHparams
|
|
returns the number of bytes successfully encoded or a value <= 0
|
|
if an error occurs.
|
|
.Sh SEE ALSO
|
|
.Xr d2i_X509 3 ,
|
|
.Xr DH_new 3
|
|
.Sh HISTORY
|
|
.Fn d2i_DHparams
|
|
and
|
|
.Fn i2d_DHparams
|
|
first appeared in SSLeay 0.5.1 and have been available since
|
|
.Ox 2.4 .
|