path: root/src/lib/libcrypto/man/d2i_DSAPublicKey.3

.\"	$OpenBSD: d2i_DSAPublicKey.3,v 1.4 2016/12/08 20:22:08 jmc Exp $
.\"	OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400
.\"
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
.\" Copyright (c) 2002, 2003, 2013, 2015, 2016 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: December 8 2016 $
.Dt D2I_DSAPUBLICKEY 3
.Os
.Sh NAME
.Nm d2i_DSAPublicKey ,
.Nm i2d_DSAPublicKey ,
.Nm d2i_DSA_PUBKEY ,
.Nm i2d_DSA_PUBKEY ,
.Nm d2i_DSA_PUBKEY_bio ,
.Nm d2i_DSA_PUBKEY_fp ,
.Nm i2d_DSA_PUBKEY_bio ,
.Nm i2d_DSA_PUBKEY_fp ,
.Nm d2i_DSAPrivateKey ,
.Nm i2d_DSAPrivateKey ,
.Nm d2i_DSAparams ,
.Nm i2d_DSAparams ,
.Nm d2i_DSA_SIG ,
.Nm i2d_DSA_SIG
.Nd DSA key encoding and parsing functions
.Sh SYNOPSIS
.In openssl/dsa.h
.In openssl/x509.h
.Ft DSA *
.Fo d2i_DSAPublicKey
.Fa "DSA **a"
.Fa "const unsigned char **pp"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_DSAPublicKey
.Fa "const DSA *a"
.Fa "unsigned char **pp"
.Fc
.Ft DSA *
.Fo d2i_DSA_PUBKEY
.Fa "DSA **a"
.Fa "const unsigned char **pp"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_DSA_PUBKEY
.Fa "const DSA *a"
.Fa "unsigned char **pp"
.Fc
.Ft DSA *
.Fo d2i_DSA_PUBKEY_bio
.Fa "BIO *bp"
.Fa "DSA **dsa"
.Fc
.Ft DSA *
.Fo d2i_DSA_PUBKEY_fp
.Fa "FILE *fp"
.Fa "DSA *dsa"
.Fc
.Ft int
.Fo i2d_DSA_PUBKEY_bio
.Fa "BIO *bp"
.Fa "DSA *dsa"
.Fc
.Ft int
.Fo i2d_DSA_PUBKEY_fp
.Fa "FILE *fp"
.Fa "DSA *dsa"
.Fc
.Ft DSA *
.Fo d2i_DSAPrivateKey
.Fa "DSA **a"
.Fa "const unsigned char **pp"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_DSAPrivateKey
.Fa "const DSA *a"
.Fa "unsigned char **pp"
.Fc
.Ft DSA *
.Fo d2i_DSAparams
.Fa "DSA **a"
.Fa "const unsigned char **pp"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_DSAparams
.Fa "const DSA *a"
.Fa "unsigned char **pp"
.Fc
.Ft DSA *
.Fo d2i_DSA_SIG
.Fa "DSA_SIG **a"
.Fa "const unsigned char **pp"
.Fa "long length"
.Fc
.Ft int
.Fo i2d_DSA_SIG
.Fa "const DSA_SIG *a"
.Fa "unsigned char **pp"
.Fc
.Sh DESCRIPTION
.Fn d2i_DSAPublicKey
and
.Fn i2d_DSAPublicKey
decode and encode the DSA public key components structure.
.Pp
.Fn d2i_DSA_PUBKEY
and
.Fn i2d_DSA_PUBKEY
decode and encode a DSA public key using a SubjectPublicKeyInfo
(certificate public key) structure.
.Pp
.Fn d2i_DSA_PUBKEY_bio ,
.Fn d2i_DSA_PUBKEY_fp ,
.Fn i2d_DSA_PUBKEY_bio ,
and
.Fn i2d_DSA_PUBKEY_fp
are similar to
.Fn d2i_DSA_PUBKEY
and
.Fn i2d_DSA_PUBKEY
except that they decode or encode using a
.Vt BIO
or
.Vt FILE
pointer.
.Pp
.Fn d2i_DSAPrivateKey
and
.Fn i2d_DSAPrivateKey
decode and encode the DSA private key components.
.Pp
.Fn d2i_DSAparams
and
.Fn i2d_DSAparams
decode and encode the DSA parameters using a
.Sy Dss-Parms
structure as defined in RFC 2459.
.Pp
.Fn d2i_DSA_SIG
and
.Fn i2d_DSA_SIG
decode and encode a DSA signature using a
.Sy Dss-Sig-Value
structure as defined in RFC 2459.
.Pp
The usage of all of these functions is similar to
.Xr d2i_X509 3
and
.Xr i2d_X509 3 .
.Pp
The
.Vt DSA
structure passed to the private key encoding functions should have all
the private key components present.
.Pp
The data encoded by the private key functions is unencrypted and
therefore offers no private key security.
.Pp
The
.Fn *_DSA_PUBKEY
functions should be used in preference to the
.Fn *_DSAPublicKey
functions when encoding public keys because they use a standard format.
.Pp
The
.Fn *_DSAPublicKey
functions use a non-standard format.
The actual data encoded depends on the value of
.Fa a->write_params .
If
.Fa a->write_params
is zero, then only the
.Fa a->pub_key
field is encoded as an
.Sy INTEGER .
If
.Fa a->write_params
is 1, then a
.Sy SEQUENCE
consisting of the
.Fa a->p ,
.Fa a->q ,
.Fa a->g ,
and
.Fa a->pub_key
fields is encoded.
.Pp
The
.Fn *_DSAPrivateKey
functions also use a non-standard structure consisting of a
SEQUENCE containing the
.Fa a->p ,
.Fa a->q ,
.Fa a->g ,
.Fa a->pub_key ,
and
.Fa a->priv_key
fields.
.Sh SEE ALSO
.Xr d2i_X509 3