summaryrefslogtreecommitdiffstats
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2016-12-10 22:53:31 +0000
committerschwarze <schwarze@openbsd.org>2016-12-10 22:53:31 +0000
commitd151c9b9a38b9fe406bbd8c51539eb7910c259f1 (patch)
tree55a833a69df0bfa06a56d4fa01dc450bd3c96b52 /lib/libcrypto/man
parentChange all references to dsa(3) to point to DSA_new(3). (diff)
downloadwireguard-openbsd-d151c9b9a38b9fe406bbd8c51539eb7910c259f1.tar.xz
wireguard-openbsd-d151c9b9a38b9fe406bbd8c51539eb7910c259f1.zip
Merge one sentence and the references from dsa(3) to DSA_new(3) and
discard the rest of the text. There is no value in documenting some of the fields of a structure and then going on to say that the structure is intended as opaque. Besides, i doubt that we want such strong marketing of ENGINE support.
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/DSA_new.326
-rw-r--r--lib/libcrypto/man/Makefile3
-rw-r--r--lib/libcrypto/man/dsa.374
3 files changed, 23 insertions, 80 deletions
diff --git a/lib/libcrypto/man/DSA_new.3 b/lib/libcrypto/man/DSA_new.3
index 0bba93b25d2..bea1814c8fc 100644
--- a/lib/libcrypto/man/DSA_new.3
+++ b/lib/libcrypto/man/DSA_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: DSA_new.3,v 1.3 2016/11/21 13:05:24 schwarze Exp $
+.\" $OpenBSD: DSA_new.3,v 1.4 2016/12/10 22:53:31 schwarze Exp $
.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Ulf Moeller <ulf@openssl.org>.
@@ -48,7 +48,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: November 21 2016 $
+.Dd $Mdocdate: December 10 2016 $
.Dt DSA_NEW 3
.Os
.Sh NAME
@@ -64,6 +64,8 @@
.Fa "DSA *dsa"
.Fc
.Sh DESCRIPTION
+The DSA functions implement the Digital Signature Algorithm.
+.Pp
.Fn DSA_new
allocates and initializes a
.Vt DSA
@@ -90,10 +92,26 @@ and sets an error code that can be obtained by
.Xr ERR_get_error 3 .
Otherwise it returns a pointer to the newly allocated structure.
.Sh SEE ALSO
-.Xr dsa 3 ,
+.Xr BN_new 3 ,
+.Xr d2i_DSAPublicKey 3 ,
+.Xr DH_new 3 ,
+.Xr DSA_do_sign 3 ,
+.Xr DSA_dup_DH 3 ,
.Xr DSA_generate_key 3 ,
.Xr DSA_generate_parameters 3 ,
-.Xr ERR_get_error 3
+.Xr DSA_get_ex_new_index 3 ,
+.Xr DSA_new 3 ,
+.Xr DSA_print 3 ,
+.Xr DSA_set_method 3 ,
+.Xr DSA_SIG_new 3 ,
+.Xr DSA_sign 3 ,
+.Xr DSA_size 3 ,
+.Xr engine 3 ,
+.Xr ERR_get_error 3 ,
+.Xr RSA_new 3
+.Sh STANDARDS
+US Federal Information Processing Standard FIPS 186 (Digital Signature
+Standard, DSS), ANSI X9.30
.Sh HISTORY
.Fn DSA_new
and
diff --git a/lib/libcrypto/man/Makefile b/lib/libcrypto/man/Makefile
index bdf52322125..ca8fec58fdf 100644
--- a/lib/libcrypto/man/Makefile
+++ b/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.70 2016/12/10 22:30:54 schwarze Exp $
+# $OpenBSD: Makefile,v 1.71 2016/12/10 22:53:31 schwarze Exp $
.include <bsd.own.mk>
@@ -213,7 +213,6 @@ MAN= \
d2i_X509_REQ.3 \
d2i_X509_SIG.3 \
des_read_pw.3 \
- dsa.3 \
ec.3 \
engine.3 \
evp.3 \
diff --git a/lib/libcrypto/man/dsa.3 b/lib/libcrypto/man/dsa.3
deleted file mode 100644
index 78493635fba..00000000000
--- a/lib/libcrypto/man/dsa.3
+++ /dev/null
@@ -1,74 +0,0 @@
-.\" $OpenBSD: dsa.3,v 1.5 2016/12/10 22:22:59 schwarze Exp $
-.\"
-.Dd $Mdocdate: December 10 2016 $
-.Dt DSA 3
-.Os
-.Sh NAME
-.Nm dsa
-.Nd Digital Signature Algorithm
-.Sh SYNOPSIS
-.In openssl/dsa.h
-.Sh DESCRIPTION
-These functions implement the Digital Signature Algorithm (DSA).
-The generation of shared DSA parameters is described in
-.Xr DSA_generate_parameters 3 ;
-.Xr DSA_generate_key 3
-describes how to generate a signature key.
-Signature generation and verification are described in
-.Xr DSA_sign 3 .
-.Pp
-The
-.Vt DSA
-structure consists of several BIGNUM components.
-.Bd -literal
-typedef struct {
- BIGNUM *p; // prime number (public)
- BIGNUM *q; // 160-bit subprime, q | p-1 (public)
- BIGNUM *g; // generator of subgroup (public)
- BIGNUM *priv_key; // private key x
- BIGNUM *pub_key; // public key y = g^x
- // ...
-} DSA;
-.Ed
-.Pp
-In public keys,
-.Fa priv_key
-is
-.Dv NULL .
-.Pp
-Note that DSA keys may use non-standard
-.Vt DSA_METHOD
-implementations, either directly or by the use of
-.Vt ENGINE
-modules.
-In some cases (e.g. an
-.Vt ENGINE
-providing support for hardware-embedded keys), these
-.Vt BIGNUM
-values will not be used by the implementation or may be used for
-alternative data storage.
-For this reason, applications should generally avoid using
-.Vt DSA
-structure elements directly and instead use API functions to query
-or modify keys.
-.Sh SEE ALSO
-.Xr BN_new 3 ,
-.Xr d2i_DSAPublicKey 3 ,
-.Xr DH_new 3 ,
-.Xr DSA_do_sign 3 ,
-.Xr DSA_dup_DH 3 ,
-.Xr DSA_generate_key 3 ,
-.Xr DSA_generate_parameters 3 ,
-.Xr DSA_get_ex_new_index 3 ,
-.Xr DSA_new 3 ,
-.Xr DSA_print 3 ,
-.Xr DSA_set_method 3 ,
-.Xr DSA_SIG_new 3 ,
-.Xr DSA_sign 3 ,
-.Xr DSA_size 3 ,
-.Xr engine 3 ,
-.Xr ERR 3 ,
-.Xr rsa 3
-.Sh STANDARDS
-US Federal Information Processing Standard FIPS 186 (Digital Signature
-Standard, DSS), ANSI X9.30