diff options
| author | schwarze <> | 2016-12-10 22:53:31 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-12-10 22:53:31 +0000 |
| commit | a88f3c227f55731a4a000617a2b4735f0f0aaf86 (patch) | |
| tree | fb9d025763d1cbf4e1f556e7ff5e5e0a654b5bc3 /src | |
| parent | 658ebcf70d6682438d1d7788358e0e857753530a (diff) | |
| download | openbsd-a88f3c227f55731a4a000617a2b4735f0f0aaf86.tar.gz openbsd-a88f3c227f55731a4a000617a2b4735f0f0aaf86.tar.bz2 openbsd-a88f3c227f55731a4a000617a2b4735f0f0aaf86.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 'src')
| -rw-r--r-- | src/lib/libcrypto/man/DSA_new.3 | 26 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/Makefile | 3 | ||||
| -rw-r--r-- | src/lib/libcrypto/man/dsa.3 | 74 |
3 files changed, 23 insertions, 80 deletions
diff --git a/src/lib/libcrypto/man/DSA_new.3 b/src/lib/libcrypto/man/DSA_new.3 index 0bba93b25d..bea1814c8f 100644 --- a/src/lib/libcrypto/man/DSA_new.3 +++ b/src/lib/libcrypto/man/DSA_new.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: DSA_new.3,v 1.3 2016/11/21 13:05:24 schwarze Exp $ | 1 | .\" $OpenBSD: DSA_new.3,v 1.4 2016/12/10 22:53:31 schwarze Exp $ |
| 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Ulf Moeller <ulf@openssl.org>. | 4 | .\" This file was written by Ulf Moeller <ulf@openssl.org>. |
| @@ -48,7 +48,7 @@ | |||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 50 | .\" | 50 | .\" |
| 51 | .Dd $Mdocdate: November 21 2016 $ | 51 | .Dd $Mdocdate: December 10 2016 $ |
| 52 | .Dt DSA_NEW 3 | 52 | .Dt DSA_NEW 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| @@ -64,6 +64,8 @@ | |||
| 64 | .Fa "DSA *dsa" | 64 | .Fa "DSA *dsa" |
| 65 | .Fc | 65 | .Fc |
| 66 | .Sh DESCRIPTION | 66 | .Sh DESCRIPTION |
| 67 | The DSA functions implement the Digital Signature Algorithm. | ||
| 68 | .Pp | ||
| 67 | .Fn DSA_new | 69 | .Fn DSA_new |
| 68 | allocates and initializes a | 70 | allocates and initializes a |
| 69 | .Vt DSA | 71 | .Vt DSA |
| @@ -90,10 +92,26 @@ and sets an error code that can be obtained by | |||
| 90 | .Xr ERR_get_error 3 . | 92 | .Xr ERR_get_error 3 . |
| 91 | Otherwise it returns a pointer to the newly allocated structure. | 93 | Otherwise it returns a pointer to the newly allocated structure. |
| 92 | .Sh SEE ALSO | 94 | .Sh SEE ALSO |
| 93 | .Xr dsa 3 , | 95 | .Xr BN_new 3 , |
| 96 | .Xr d2i_DSAPublicKey 3 , | ||
| 97 | .Xr DH_new 3 , | ||
| 98 | .Xr DSA_do_sign 3 , | ||
| 99 | .Xr DSA_dup_DH 3 , | ||
| 94 | .Xr DSA_generate_key 3 , | 100 | .Xr DSA_generate_key 3 , |
| 95 | .Xr DSA_generate_parameters 3 , | 101 | .Xr DSA_generate_parameters 3 , |
| 96 | .Xr ERR_get_error 3 | 102 | .Xr DSA_get_ex_new_index 3 , |
| 103 | .Xr DSA_new 3 , | ||
| 104 | .Xr DSA_print 3 , | ||
| 105 | .Xr DSA_set_method 3 , | ||
| 106 | .Xr DSA_SIG_new 3 , | ||
| 107 | .Xr DSA_sign 3 , | ||
| 108 | .Xr DSA_size 3 , | ||
| 109 | .Xr engine 3 , | ||
| 110 | .Xr ERR_get_error 3 , | ||
| 111 | .Xr RSA_new 3 | ||
| 112 | .Sh STANDARDS | ||
| 113 | US Federal Information Processing Standard FIPS 186 (Digital Signature | ||
| 114 | Standard, DSS), ANSI X9.30 | ||
| 97 | .Sh HISTORY | 115 | .Sh HISTORY |
| 98 | .Fn DSA_new | 116 | .Fn DSA_new |
| 99 | and | 117 | and |
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index bdf5232212..ca8fec58fd 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # $OpenBSD: Makefile,v 1.70 2016/12/10 22:30:54 schwarze Exp $ | 1 | # $OpenBSD: Makefile,v 1.71 2016/12/10 22:53:31 schwarze Exp $ |
| 2 | 2 | ||
| 3 | .include <bsd.own.mk> | 3 | .include <bsd.own.mk> |
| 4 | 4 | ||
| @@ -213,7 +213,6 @@ MAN= \ | |||
| 213 | d2i_X509_REQ.3 \ | 213 | d2i_X509_REQ.3 \ |
| 214 | d2i_X509_SIG.3 \ | 214 | d2i_X509_SIG.3 \ |
| 215 | des_read_pw.3 \ | 215 | des_read_pw.3 \ |
| 216 | dsa.3 \ | ||
| 217 | ec.3 \ | 216 | ec.3 \ |
| 218 | engine.3 \ | 217 | engine.3 \ |
| 219 | evp.3 \ | 218 | evp.3 \ |
diff --git a/src/lib/libcrypto/man/dsa.3 b/src/lib/libcrypto/man/dsa.3 deleted file mode 100644 index 78493635fb..0000000000 --- a/src/lib/libcrypto/man/dsa.3 +++ /dev/null | |||
| @@ -1,74 +0,0 @@ | |||
| 1 | .\" $OpenBSD: dsa.3,v 1.5 2016/12/10 22:22:59 schwarze Exp $ | ||
| 2 | .\" | ||
| 3 | .Dd $Mdocdate: December 10 2016 $ | ||
| 4 | .Dt DSA 3 | ||
| 5 | .Os | ||
| 6 | .Sh NAME | ||
| 7 | .Nm dsa | ||
| 8 | .Nd Digital Signature Algorithm | ||
| 9 | .Sh SYNOPSIS | ||
| 10 | .In openssl/dsa.h | ||
| 11 | .Sh DESCRIPTION | ||
| 12 | These functions implement the Digital Signature Algorithm (DSA). | ||
| 13 | The generation of shared DSA parameters is described in | ||
| 14 | .Xr DSA_generate_parameters 3 ; | ||
| 15 | .Xr DSA_generate_key 3 | ||
| 16 | describes how to generate a signature key. | ||
| 17 | Signature generation and verification are described in | ||
| 18 | .Xr DSA_sign 3 . | ||
| 19 | .Pp | ||
| 20 | The | ||
| 21 | .Vt DSA | ||
| 22 | structure consists of several BIGNUM components. | ||
| 23 | .Bd -literal | ||
| 24 | typedef struct { | ||
| 25 | BIGNUM *p; // prime number (public) | ||
| 26 | BIGNUM *q; // 160-bit subprime, q | p-1 (public) | ||
| 27 | BIGNUM *g; // generator of subgroup (public) | ||
| 28 | BIGNUM *priv_key; // private key x | ||
| 29 | BIGNUM *pub_key; // public key y = g^x | ||
| 30 | // ... | ||
| 31 | } DSA; | ||
| 32 | .Ed | ||
| 33 | .Pp | ||
| 34 | In public keys, | ||
| 35 | .Fa priv_key | ||
| 36 | is | ||
| 37 | .Dv NULL . | ||
| 38 | .Pp | ||
| 39 | Note that DSA keys may use non-standard | ||
| 40 | .Vt DSA_METHOD | ||
| 41 | implementations, either directly or by the use of | ||
| 42 | .Vt ENGINE | ||
| 43 | modules. | ||
| 44 | In some cases (e.g. an | ||
| 45 | .Vt ENGINE | ||
| 46 | providing support for hardware-embedded keys), these | ||
| 47 | .Vt BIGNUM | ||
| 48 | values will not be used by the implementation or may be used for | ||
| 49 | alternative data storage. | ||
| 50 | For this reason, applications should generally avoid using | ||
| 51 | .Vt DSA | ||
| 52 | structure elements directly and instead use API functions to query | ||
| 53 | or modify keys. | ||
| 54 | .Sh SEE ALSO | ||
| 55 | .Xr BN_new 3 , | ||
| 56 | .Xr d2i_DSAPublicKey 3 , | ||
| 57 | .Xr DH_new 3 , | ||
| 58 | .Xr DSA_do_sign 3 , | ||
| 59 | .Xr DSA_dup_DH 3 , | ||
| 60 | .Xr DSA_generate_key 3 , | ||
| 61 | .Xr DSA_generate_parameters 3 , | ||
| 62 | .Xr DSA_get_ex_new_index 3 , | ||
| 63 | .Xr DSA_new 3 , | ||
| 64 | .Xr DSA_print 3 , | ||
| 65 | .Xr DSA_set_method 3 , | ||
| 66 | .Xr DSA_SIG_new 3 , | ||
| 67 | .Xr DSA_sign 3 , | ||
| 68 | .Xr DSA_size 3 , | ||
| 69 | .Xr engine 3 , | ||
| 70 | .Xr ERR 3 , | ||
| 71 | .Xr rsa 3 | ||
| 72 | .Sh STANDARDS | ||
| 73 | US Federal Information Processing Standard FIPS 186 (Digital Signature | ||
| 74 | Standard, DSS), ANSI X9.30 | ||
