diff options
author | schwarze <> | 2015-11-12 00:55:49 +0000 |
---|---|---|
committer | schwarze <> | 2015-11-12 00:55:49 +0000 |
commit | d87f13d29bdce02ae37ef5da3fb9e0227724e57b (patch) | |
tree | 7050351f491582d85dae8d06f9530073074006fe /src/lib/libcrypto/man | |
parent | 3681e43b7101c2171779b147addaa726f1373b2b (diff) | |
download | openbsd-d87f13d29bdce02ae37ef5da3fb9e0227724e57b.tar.gz openbsd-d87f13d29bdce02ae37ef5da3fb9e0227724e57b.tar.bz2 openbsd-d87f13d29bdce02ae37ef5da3fb9e0227724e57b.zip |
Convert the handful of manuals that had imaginary names,
give them names that really exist.
This also helps jmc@'s ongoing work on improving NAME sections.
Diffstat (limited to 'src/lib/libcrypto/man')
-rw-r--r-- | src/lib/libcrypto/man/ECDSA_SIG_new.3 | 396 | ||||
-rw-r--r-- | src/lib/libcrypto/man/Makefile | 192 | ||||
-rw-r--r-- | src/lib/libcrypto/man/bn_dump.3 | 713 | ||||
-rw-r--r-- | src/lib/libcrypto/man/d2i_PKCS8PrivateKey_bio.3 | 97 | ||||
-rw-r--r-- | src/lib/libcrypto/man/des_read_pw.3 | 97 | ||||
-rw-r--r-- | src/lib/libcrypto/man/lh_new.3 | 430 | ||||
-rw-r--r-- | src/lib/libcrypto/man/ui_new.3 | 384 |
7 files changed, 2210 insertions, 99 deletions
diff --git a/src/lib/libcrypto/man/ECDSA_SIG_new.3 b/src/lib/libcrypto/man/ECDSA_SIG_new.3 new file mode 100644 index 0000000000..422ccdeb42 --- /dev/null +++ b/src/lib/libcrypto/man/ECDSA_SIG_new.3 | |||
@@ -0,0 +1,396 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt ECDSA_SIG_NEW 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm ECDSA_SIG_new , | ||
6 | .Nm ECDSA_SIG_free , | ||
7 | .Nm i2d_ECDSA_SIG , | ||
8 | .Nm d2i_ECDSA_SIG , | ||
9 | .Nm ECDSA_size , | ||
10 | .Nm ECDSA_sign_setup , | ||
11 | .Nm ECDSA_sign , | ||
12 | .Nm ECDSA_sign_ex , | ||
13 | .Nm ECDSA_verify , | ||
14 | .Nm ECDSA_do_sign , | ||
15 | .Nm ECDSA_do_sign_ex , | ||
16 | .Nm ECDSA_do_verify , | ||
17 | .Nm ECDSA_OpenSSL , | ||
18 | .Nm ECDSA_get_default_method , | ||
19 | .Nm ECDSA_get_ex_data , | ||
20 | .Nm ECDSA_get_ex_new_index , | ||
21 | .Nm ECDSA_set_default_method , | ||
22 | .Nm ECDSA_set_ex_data , | ||
23 | .Nm ECDSA_set_method | ||
24 | .Nd Elliptic Curve Digital Signature Algorithm | ||
25 | .Sh SYNOPSIS | ||
26 | .In openssl/ecdsa.h | ||
27 | .Ft ECDSA_SIG* | ||
28 | .Fo ECDSA_SIG_new | ||
29 | .Fa void | ||
30 | .Fc | ||
31 | .Ft void | ||
32 | .Fo ECDSA_SIG_free | ||
33 | .Fa "ECDSA_SIG *sig" | ||
34 | .Fc | ||
35 | .Ft int | ||
36 | .Fo i2d_ECDSA_SIG | ||
37 | .Fa "const ECDSA_SIG *sig" | ||
38 | .Fa "unsigned char **pp" | ||
39 | .Fc | ||
40 | .Ft ECDSA_SIG* | ||
41 | .Fo d2i_ECDSA_SIG | ||
42 | .Fa "ECDSA_SIG **sig" | ||
43 | .Fa "const unsigned char **pp" | ||
44 | .Fa "long len" | ||
45 | .Fc | ||
46 | .Ft ECDSA_SIG* | ||
47 | .Fo ECDSA_do_sign | ||
48 | .Fa "const unsigned char *dgst" | ||
49 | .Fa "int dgst_len" | ||
50 | .Fa "EC_KEY *eckey" | ||
51 | .Fc | ||
52 | .Ft ECDSA_SIG* | ||
53 | .Fo ECDSA_do_sign_ex | ||
54 | .Fa "const unsigned char *dgst" | ||
55 | .Fa "int dgstlen" | ||
56 | .Fa "const BIGNUM *kinv" | ||
57 | .Fa "const BIGNUM *rp" | ||
58 | .Fa "EC_KEY *eckey" | ||
59 | .Fc | ||
60 | .Ft int | ||
61 | .Fo ECDSA_do_verify | ||
62 | .Fa "const unsigned char *dgst" | ||
63 | .Fa "int dgst_len" | ||
64 | .Fa "const ECDSA_SIG *sig" | ||
65 | .Fa "EC_KEY* eckey" | ||
66 | .Fc | ||
67 | .Ft int | ||
68 | .Fo ECDSA_sign_setup | ||
69 | .Fa "EC_KEY *eckey" | ||
70 | .Fa "BN_CTX *ctx" | ||
71 | .Fa "BIGNUM **kinv" | ||
72 | .Fa "BIGNUM **rp" | ||
73 | .Fc | ||
74 | .Ft int | ||
75 | .Fo ECDSA_sign | ||
76 | .Fa "int type" | ||
77 | .Fa "const unsigned char *dgst" | ||
78 | .Fa "int dgstlen" | ||
79 | .Fa "unsigned char *sig" | ||
80 | .Fa "unsigned int *siglen" | ||
81 | .Fa "EC_KEY *eckey" | ||
82 | .Fc | ||
83 | .Ft int | ||
84 | .Fo ECDSA_sign_ex | ||
85 | .Fa "int type" | ||
86 | .Fa "const unsigned char *dgst" | ||
87 | .Fa "int dgstlen" | ||
88 | .Fa "unsigned char *sig" | ||
89 | .Fa "unsigned int *siglen" | ||
90 | .Fa "const BIGNUM *kinv" | ||
91 | .Fa "const BIGNUM *rp" | ||
92 | .Fa "EC_KEY *eckey" | ||
93 | .Fc | ||
94 | .Ft int | ||
95 | .Fo ECDSA_verify | ||
96 | .Fa "int type" | ||
97 | .Fa "const unsigned char *dgst" | ||
98 | .Fa "int dgstlen" | ||
99 | .Fa "const unsigned char *sig" | ||
100 | .Fa "int siglen" | ||
101 | .Fa "EC_KEY *eckey" | ||
102 | .Fc | ||
103 | .Ft int | ||
104 | .Fo ECDSA_size | ||
105 | .Fa "const EC_KEY *eckey" | ||
106 | .Fc | ||
107 | .Ft const ECDSA_METHOD* | ||
108 | .Fo ECDSA_OpenSSL | ||
109 | .Fa void | ||
110 | .Fc | ||
111 | .Ft void | ||
112 | .Fo ECDSA_set_default_method | ||
113 | .Fa "const ECDSA_METHOD *meth" | ||
114 | .Fc | ||
115 | .Ft const ECDSA_METHOD* | ||
116 | .Fo ECDSA_get_default_method | ||
117 | .Fa void | ||
118 | .Fc | ||
119 | .Ft int | ||
120 | .Fo ECDSA_set_method | ||
121 | .Fa "EC_KEY *eckey" | ||
122 | .Fa "const ECDSA_METHOD *meth" | ||
123 | .Fc | ||
124 | .Ft int | ||
125 | .Fo ECDSA_get_ex_new_index | ||
126 | .Fa "long argl" | ||
127 | .Fa "void *argp" | ||
128 | .Fa "CRYPTO_EX_new *new_func" | ||
129 | .Fa "CRYPTO_EX_dup *dup_func" | ||
130 | .Fa "CRYPTO_EX_free *free_func" | ||
131 | .Fc | ||
132 | .Ft int | ||
133 | .Fo ECDSA_set_ex_data | ||
134 | .Fa "EC_KEY *d" | ||
135 | .Fa "int idx" | ||
136 | .Fa "void *arg" | ||
137 | .Fc | ||
138 | .Ft void* | ||
139 | .Fo ECDSA_get_ex_data | ||
140 | .Fa "EC_KEY *d" | ||
141 | .Fa "int idx" | ||
142 | .Fc | ||
143 | .Sh DESCRIPTION | ||
144 | The | ||
145 | .Vt ECDSA_SIG | ||
146 | structure consists of two | ||
147 | .Vt BIGNUM Ns s | ||
148 | for the | ||
149 | .Fa r | ||
150 | and | ||
151 | .Fa s | ||
152 | value of an ECDSA signature (see X9.62 or FIPS 186-2). | ||
153 | .Bd -literal -offset indent | ||
154 | struct { | ||
155 | BIGNUM *r; | ||
156 | BIGNUM *s; | ||
157 | } ECDSA_SIG; | ||
158 | .Ed | ||
159 | .Pp | ||
160 | .Fn ECDSA_SIG_new | ||
161 | allocates a new | ||
162 | .Vt ECDSA_SIG | ||
163 | structure (note: this function also allocates the | ||
164 | .Vt BIGNUM Ns s ) | ||
165 | and initialize it. | ||
166 | .Pp | ||
167 | .Fn ECDSA_SIG_free | ||
168 | frees the | ||
169 | .Vt ECDSA_SIG | ||
170 | structure | ||
171 | .Fa sig . | ||
172 | .Pp | ||
173 | .Fn i2d_ECDSA_SIG | ||
174 | creates the DER encoding of the ECDSA signature | ||
175 | .Fa sig | ||
176 | and writes the encoded signature to | ||
177 | .Fa *pp | ||
178 | (note: if | ||
179 | .Fa pp | ||
180 | is | ||
181 | .Dv NULL , | ||
182 | .Fn i2d_ECDSA_SIG | ||
183 | returns the expected length in bytes of the DER encoded signature). | ||
184 | .Fn i2d_ECDSA_SIG | ||
185 | returns the length of the DER encoded signature (or 0 on error). | ||
186 | .Pp | ||
187 | .Fn d2i_ECDSA_SIG | ||
188 | decodes a DER encoded ECDSA signature and returns the decoded signature | ||
189 | in a newly allocated | ||
190 | .Vt ECDSA_SIG | ||
191 | structure. | ||
192 | .Fa *sig | ||
193 | points to the buffer containing the DER encoded signature of size | ||
194 | .Fa len . | ||
195 | .Pp | ||
196 | .Fn ECDSA_size | ||
197 | returns the maximum length of a DER encoded ECDSA signature created with | ||
198 | the private EC key | ||
199 | .Fa eckey . | ||
200 | .Pp | ||
201 | .Fn ECDSA_sign_setup | ||
202 | may be used to precompute parts of the signing operation. | ||
203 | .Fa eckey | ||
204 | is the private EC key and | ||
205 | .Fa ctx | ||
206 | is a pointer to a | ||
207 | .Vt BN_CTX | ||
208 | structure (or | ||
209 | .Dv NULL ) . | ||
210 | The precomputed values or returned in | ||
211 | .Fa kinv | ||
212 | and | ||
213 | .Fa rp | ||
214 | and can be used in a later call to | ||
215 | .Fa ECDSA_sign_ex | ||
216 | or | ||
217 | .Fa ECDSA_do_sign_ex . | ||
218 | .Pp | ||
219 | .Fn ECDSA_sign | ||
220 | is wrapper function for | ||
221 | .Fa ECDSA_sign_ex | ||
222 | with | ||
223 | .Fa kinv | ||
224 | and | ||
225 | .Fa rp | ||
226 | set to | ||
227 | .Dv NULL . | ||
228 | .Pp | ||
229 | .Fn ECDSA_sign_ex | ||
230 | computes a digital signature of the | ||
231 | .Fa dgstlen | ||
232 | bytes hash value | ||
233 | .Fa dgst | ||
234 | using the private EC key | ||
235 | .Fa eckey | ||
236 | and the optional pre-computed values | ||
237 | .Fa kinv | ||
238 | and | ||
239 | .Fa rp . | ||
240 | The DER encoded signatures is stored in | ||
241 | .Fa sig | ||
242 | and its length is returned in | ||
243 | .Fa siglen . | ||
244 | Note: | ||
245 | .Fa sig | ||
246 | must point to | ||
247 | .Fn ECDSA_size | ||
248 | bytes of memory. | ||
249 | The parameter | ||
250 | .Fa type | ||
251 | is ignored. | ||
252 | .Pp | ||
253 | .Fn ECDSA_verify | ||
254 | verifies that the signature in | ||
255 | .Fa sig | ||
256 | of size | ||
257 | .Fa siglen | ||
258 | is a valid ECDSA signature of the hash value | ||
259 | .Fa dgst | ||
260 | of size | ||
261 | .Fa dgstlen | ||
262 | using the public key | ||
263 | .Fa eckey . | ||
264 | The parameter | ||
265 | .Fa type | ||
266 | is ignored. | ||
267 | .Pp | ||
268 | .Fn ECDSA_do_sign | ||
269 | is wrapper function for ECDSA_do_sign_ex with | ||
270 | .Fa kinv | ||
271 | and | ||
272 | .Fa rp | ||
273 | set to | ||
274 | .Dv NULL . | ||
275 | .Pp | ||
276 | .Fn ECDSA_do_sign_ex | ||
277 | computes a digital signature of the | ||
278 | .Fa dgst_len | ||
279 | bytes hash value | ||
280 | .Fa dgst | ||
281 | using the private key | ||
282 | .Fa eckey | ||
283 | and the optional pre-computed values | ||
284 | .Fa kinv | ||
285 | and | ||
286 | .Fa rp . | ||
287 | The signature is returned in a newly allocated | ||
288 | .Vt ECDSA_SIG | ||
289 | structure (or | ||
290 | .Dv NULL | ||
291 | on error). | ||
292 | .Pp | ||
293 | .Fn ECDSA_do_verify | ||
294 | verifies that the signature | ||
295 | .Fa sig | ||
296 | is a valid ECDSA signature of the hash value | ||
297 | .Fa dgst | ||
298 | of size | ||
299 | .Fa dgst_len | ||
300 | using the public key | ||
301 | .Fa eckey . | ||
302 | .Sh RETURN VALUES | ||
303 | .Fn ECDSA_size | ||
304 | returns the maximum length signature or 0 on error. | ||
305 | .Pp | ||
306 | .Fn ECDSA_sign_setup | ||
307 | and | ||
308 | .Fn ECDSA_sign | ||
309 | return 1 if successful or 0 on error. | ||
310 | .Pp | ||
311 | .Fn ECDSA_verify | ||
312 | and | ||
313 | .Fn ECDSA_do_verify | ||
314 | return 1 for a valid signature, 0 for an invalid signature and -1 on | ||
315 | error. | ||
316 | The error codes can be obtained by | ||
317 | .Xr ERR_get_error 3 . | ||
318 | .Sh EXAMPLES | ||
319 | Creating a ECDSA signature of given SHA-1 hash value using the named | ||
320 | curve secp192k1. | ||
321 | .Pp | ||
322 | First step: Create an | ||
323 | .Vt EC_KEY | ||
324 | object. | ||
325 | This part is | ||
326 | .Em not | ||
327 | ECDSA specific. | ||
328 | .Bd -literal -offset indent | ||
329 | int ret; | ||
330 | ECDSA_SIG *sig; | ||
331 | EC_KEY *eckey; | ||
332 | |||
333 | eckey = EC_KEY_new_by_curve_name(NID_secp192k1); | ||
334 | if (eckey == NULL) { | ||
335 | /* error */ | ||
336 | } | ||
337 | if (!EC_KEY_generate_key(eckey)) { | ||
338 | /* error */ | ||
339 | } | ||
340 | .Ed | ||
341 | .Pp | ||
342 | Second step: compute the ECDSA signature of a SHA-1 hash value using | ||
343 | .Fn ECDSA_do_sign | ||
344 | .Bd -literal -offset indent | ||
345 | sig = ECDSA_do_sign(digest, 20, eckey); | ||
346 | if (sig == NULL) { | ||
347 | /* error */ | ||
348 | } | ||
349 | .Ed | ||
350 | .Pp | ||
351 | or using | ||
352 | .Fn ECDSA_sign | ||
353 | .Bd -literal -offset indent | ||
354 | unsigned char *buffer, *pp; | ||
355 | int buf_len; | ||
356 | |||
357 | buf_len = ECDSA_size(eckey); | ||
358 | buffer = malloc(buf_len); | ||
359 | pp = buffer; | ||
360 | if (!ECDSA_sign(0, dgst, dgstlen, pp, &buf_len, eckey) { | ||
361 | /* error */ | ||
362 | } | ||
363 | .Ed | ||
364 | .Pp | ||
365 | Third step: Verify the created ECDSA signature using | ||
366 | .Fn ECDSA_do_verify | ||
367 | .Pp | ||
368 | .Dl ret = ECDSA_do_verify(digest, 20, sig, eckey); | ||
369 | .Pp | ||
370 | or using | ||
371 | .Fn ECDSA_verify | ||
372 | .Pp | ||
373 | .Dl ret = ECDSA_verify(0, digest, 20, buffer, buf_len, eckey); | ||
374 | .Pp | ||
375 | and finally evaluate the return value: | ||
376 | .Bd -literal -offset indent | ||
377 | if (ret == -1) { | ||
378 | /* error */ | ||
379 | } else if (ret == 0) { | ||
380 | /* incorrect signature */ | ||
381 | } else { | ||
382 | /* ret == 1 */ | ||
383 | /* signature ok */ | ||
384 | } | ||
385 | .Ed | ||
386 | .Sh SEE ALSO | ||
387 | .Xr dsa 3 , | ||
388 | .Xr rsa 3 | ||
389 | .Sh STANDARDS | ||
390 | ANSI X9.62, US Federal Information Processing Standard FIPS 186-2 | ||
391 | (Digital Signature Standard, DSS) | ||
392 | .Sh HISTORY | ||
393 | The ecdsa implementation was first introduced in OpenSSL 0.9.8. | ||
394 | .Sh AUTHORS | ||
395 | .An Nils Larsch | ||
396 | for the OpenSSL project. | ||
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile index ecb1d51a52..86c5de26f8 100644 --- a/src/lib/libcrypto/man/Makefile +++ b/src/lib/libcrypto/man/Makefile | |||
@@ -1,4 +1,4 @@ | |||
1 | # $OpenBSD: Makefile,v 1.28 2015/11/11 22:14:39 jmc Exp $ | 1 | # $OpenBSD: Makefile,v 1.29 2015/11/12 00:55:49 schwarze Exp $ |
2 | 2 | ||
3 | .include <bsd.own.mk> # for NOMAN | 3 | .include <bsd.own.mk> # for NOMAN |
4 | 4 | ||
@@ -73,8 +73,14 @@ MAN= \ | |||
73 | CONF_modules_load_file.3 \ | 73 | CONF_modules_load_file.3 \ |
74 | CRYPTO_set_ex_data.3 \ | 74 | CRYPTO_set_ex_data.3 \ |
75 | CRYPTO_set_locking_callback.3 \ | 75 | CRYPTO_set_locking_callback.3 \ |
76 | ECDSA_SIG_new.3 \ | ||
76 | EVP_AEAD_CTX_init.3 \ | 77 | EVP_AEAD_CTX_init.3 \ |
78 | bn_dump.3 \ | ||
77 | crypto.3 \ | 79 | crypto.3 \ |
80 | d2i_PKCS8PrivateKey_bio.3 \ | ||
81 | des_read_pw.3 \ | ||
82 | lh_new.3 \ | ||
83 | ui_new.3 \ | ||
78 | 84 | ||
79 | GENMAN= \ | 85 | GENMAN= \ |
80 | DES_set_key.3 \ | 86 | DES_set_key.3 \ |
@@ -188,12 +194,10 @@ GENMAN= \ | |||
188 | X509_new.3 \ | 194 | X509_new.3 \ |
189 | X509_verify_cert.3 \ | 195 | X509_verify_cert.3 \ |
190 | bn.3 \ | 196 | bn.3 \ |
191 | bn_internal.3 \ | ||
192 | d2i_ASN1_OBJECT.3 \ | 197 | d2i_ASN1_OBJECT.3 \ |
193 | d2i_DHparams.3 \ | 198 | d2i_DHparams.3 \ |
194 | d2i_DSAPublicKey.3 \ | 199 | d2i_DSAPublicKey.3 \ |
195 | d2i_ECPKParameters.3 \ | 200 | d2i_ECPKParameters.3 \ |
196 | d2i_PKCS8PrivateKey.3 \ | ||
197 | d2i_RSAPublicKey.3 \ | 201 | d2i_RSAPublicKey.3 \ |
198 | d2i_X509.3 \ | 202 | d2i_X509.3 \ |
199 | d2i_X509_ALGOR.3 \ | 203 | d2i_X509_ALGOR.3 \ |
@@ -204,15 +208,11 @@ GENMAN= \ | |||
204 | dh.3 \ | 208 | dh.3 \ |
205 | dsa.3 \ | 209 | dsa.3 \ |
206 | ec.3 \ | 210 | ec.3 \ |
207 | ecdsa.3 \ | ||
208 | engine.3 \ | 211 | engine.3 \ |
209 | evp.3 \ | 212 | evp.3 \ |
210 | i2d_PKCS7_bio_stream.3 \ | 213 | i2d_PKCS7_bio_stream.3 \ |
211 | lh_stats.3 \ | 214 | lh_stats.3 \ |
212 | lhash.3 \ | ||
213 | rsa.3 \ | 215 | rsa.3 \ |
214 | ui.3 \ | ||
215 | ui_compat.3 \ | ||
216 | x509.3 \ | 216 | x509.3 \ |
217 | 217 | ||
218 | MAN+= ${GENMAN} | 218 | MAN+= ${GENMAN} |
@@ -605,6 +605,23 @@ MLINKS+=\ | |||
605 | EC_POINT_new.3 EC_POINT_set_compressed_coordinates_GF2m.3 \ | 605 | EC_POINT_new.3 EC_POINT_set_compressed_coordinates_GF2m.3 \ |
606 | EC_POINT_new.3 EC_POINT_set_compressed_coordinates_GFp.3 \ | 606 | EC_POINT_new.3 EC_POINT_set_compressed_coordinates_GFp.3 \ |
607 | EC_POINT_new.3 EC_POINT_set_to_infinity.3 \ | 607 | EC_POINT_new.3 EC_POINT_set_to_infinity.3 \ |
608 | ECDSA_SIG_new.3 ECDSA_OpenSSL.3 \ | ||
609 | ECDSA_SIG_new.3 ECDSA_SIG_free.3 \ | ||
610 | ECDSA_SIG_new.3 ECDSA_do_sign.3 \ | ||
611 | ECDSA_SIG_new.3 ECDSA_do_sign_ex.3 \ | ||
612 | ECDSA_SIG_new.3 ECDSA_do_verify.3 \ | ||
613 | ECDSA_SIG_new.3 ECDSA_get_default_method.3 \ | ||
614 | ECDSA_SIG_new.3 ECDSA_get_ex_data.3 \ | ||
615 | ECDSA_SIG_new.3 ECDSA_get_ex_new_index.3 \ | ||
616 | ECDSA_SIG_new.3 ECDSA_set_default_method.3 \ | ||
617 | ECDSA_SIG_new.3 ECDSA_set_ex_data.3 \ | ||
618 | ECDSA_SIG_new.3 ECDSA_set_method.3 \ | ||
619 | ECDSA_SIG_new.3 ECDSA_sign.3 \ | ||
620 | ECDSA_SIG_new.3 ECDSA_sign_ex.3 \ | ||
621 | ECDSA_SIG_new.3 ECDSA_sign_setup.3 \ | ||
622 | ECDSA_SIG_new.3 ECDSA_verify.3 \ | ||
623 | ECDSA_SIG_new.3 d2i_ECDSA_SIG.3 \ | ||
624 | ECDSA_SIG_new.3 i2d_ECDSA_SIG.3 \ | ||
608 | ERR_GET_LIB.3 ERR_GET_FUNC.3 \ | 625 | ERR_GET_LIB.3 ERR_GET_FUNC.3 \ |
609 | ERR_GET_LIB.3 ERR_GET_REASON.3 \ | 626 | ERR_GET_LIB.3 ERR_GET_REASON.3 \ |
610 | ERR_error_string.3 ERR_error_string_n.3 \ | 627 | ERR_error_string.3 ERR_error_string_n.3 \ |
@@ -982,38 +999,37 @@ MLINKS+=\ | |||
982 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_purpose.3 \ | 999 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_purpose.3 \ |
983 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_time.3 \ | 1000 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_time.3 \ |
984 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_trust.3 \ | 1001 | X509_VERIFY_PARAM_set_flags.3 X509_VERIFY_PARAM_set_trust.3 \ |
985 | bn_internal.3 bn_add_words.3 \ | 1002 | bn_dump.3 bn_add_words.3 \ |
986 | bn_internal.3 bn_check_top.3 \ | 1003 | bn_dump.3 bn_check_top.3 \ |
987 | bn_internal.3 bn_cmp_words.3 \ | 1004 | bn_dump.3 bn_cmp_words.3 \ |
988 | bn_internal.3 bn_div_words.3 \ | 1005 | bn_dump.3 bn_div_words.3 \ |
989 | bn_internal.3 bn_dump.3 \ | 1006 | bn_dump.3 bn_expand.3 \ |
990 | bn_internal.3 bn_expand.3 \ | 1007 | bn_dump.3 bn_expand2.3 \ |
991 | bn_internal.3 bn_expand2.3 \ | 1008 | bn_dump.3 bn_fix_top.3 \ |
992 | bn_internal.3 bn_fix_top.3 \ | 1009 | bn_dump.3 bn_mul_add_words.3 \ |
993 | bn_internal.3 bn_mul_add_words.3 \ | 1010 | bn_dump.3 bn_mul_comba4.3 \ |
994 | bn_internal.3 bn_mul_comba4.3 \ | 1011 | bn_dump.3 bn_mul_comba8.3 \ |
995 | bn_internal.3 bn_mul_comba8.3 \ | 1012 | bn_dump.3 bn_mul_high.3 \ |
996 | bn_internal.3 bn_mul_high.3 \ | 1013 | bn_dump.3 bn_mul_low_normal.3 \ |
997 | bn_internal.3 bn_mul_low_normal.3 \ | 1014 | bn_dump.3 bn_mul_low_recursive.3 \ |
998 | bn_internal.3 bn_mul_low_recursive.3 \ | 1015 | bn_dump.3 bn_mul_normal.3 \ |
999 | bn_internal.3 bn_mul_normal.3 \ | 1016 | bn_dump.3 bn_mul_part_recursive.3 \ |
1000 | bn_internal.3 bn_mul_part_recursive.3 \ | 1017 | bn_dump.3 bn_mul_recursive.3 \ |
1001 | bn_internal.3 bn_mul_recursive.3 \ | 1018 | bn_dump.3 bn_mul_words.3 \ |
1002 | bn_internal.3 bn_mul_words.3 \ | 1019 | bn_dump.3 bn_print.3 \ |
1003 | bn_internal.3 bn_print.3 \ | 1020 | bn_dump.3 bn_set_high.3 \ |
1004 | bn_internal.3 bn_set_high.3 \ | 1021 | bn_dump.3 bn_set_low.3 \ |
1005 | bn_internal.3 bn_set_low.3 \ | 1022 | bn_dump.3 bn_set_max.3 \ |
1006 | bn_internal.3 bn_set_max.3 \ | 1023 | bn_dump.3 bn_sqr_comba4.3 \ |
1007 | bn_internal.3 bn_sqr_comba4.3 \ | 1024 | bn_dump.3 bn_sqr_comba8.3 \ |
1008 | bn_internal.3 bn_sqr_comba8.3 \ | 1025 | bn_dump.3 bn_sqr_normal.3 \ |
1009 | bn_internal.3 bn_sqr_normal.3 \ | 1026 | bn_dump.3 bn_sqr_recursive.3 \ |
1010 | bn_internal.3 bn_sqr_recursive.3 \ | 1027 | bn_dump.3 bn_sqr_words.3 \ |
1011 | bn_internal.3 bn_sqr_words.3 \ | 1028 | bn_dump.3 bn_sub_words.3 \ |
1012 | bn_internal.3 bn_sub_words.3 \ | 1029 | bn_dump.3 bn_wexpand.3 \ |
1013 | bn_internal.3 bn_wexpand.3 \ | 1030 | bn_dump.3 mul.3 \ |
1014 | bn_internal.3 mul.3 \ | 1031 | bn_dump.3 mul_add.3 \ |
1015 | bn_internal.3 mul_add.3 \ | 1032 | bn_dump.3 sqr.3 \ |
1016 | bn_internal.3 sqr.3 \ | ||
1017 | d2i_ASN1_OBJECT.3 i2d_ASN1_OBJECT.3 \ | 1033 | d2i_ASN1_OBJECT.3 i2d_ASN1_OBJECT.3 \ |
1018 | d2i_DHparams.3 i2d_DHparams.3 \ | 1034 | d2i_DHparams.3 i2d_DHparams.3 \ |
1019 | d2i_DSAPublicKey.3 d2i_DSAPrivateKey.3 \ | 1035 | d2i_DSAPublicKey.3 d2i_DSAPrivateKey.3 \ |
@@ -1032,12 +1048,11 @@ MLINKS+=\ | |||
1032 | d2i_ECPKParameters.3 i2d_ECPKParameters.3 \ | 1048 | d2i_ECPKParameters.3 i2d_ECPKParameters.3 \ |
1033 | d2i_ECPKParameters.3 i2d_ECPKParameters_bio.3 \ | 1049 | d2i_ECPKParameters.3 i2d_ECPKParameters_bio.3 \ |
1034 | d2i_ECPKParameters.3 i2d_ECPKParameters_fp.3 \ | 1050 | d2i_ECPKParameters.3 i2d_ECPKParameters_fp.3 \ |
1035 | d2i_PKCS8PrivateKey.3 d2i_PKCS8PrivateKey_bio.3 \ | 1051 | d2i_PKCS8PrivateKey_bio.3 d2i_PKCS8PrivateKey_fp.3 \ |
1036 | d2i_PKCS8PrivateKey.3 d2i_PKCS8PrivateKey_fp.3 \ | 1052 | d2i_PKCS8PrivateKey_bio.3 i2d_PKCS8PrivateKey_bio.3 \ |
1037 | d2i_PKCS8PrivateKey.3 i2d_PKCS8PrivateKey_bio.3 \ | 1053 | d2i_PKCS8PrivateKey_bio.3 i2d_PKCS8PrivateKey_fp.3 \ |
1038 | d2i_PKCS8PrivateKey.3 i2d_PKCS8PrivateKey_fp.3 \ | 1054 | d2i_PKCS8PrivateKey_bio.3 i2d_PKCS8PrivateKey_nid_bio.3 \ |
1039 | d2i_PKCS8PrivateKey.3 i2d_PKCS8PrivateKey_nid_bio.3 \ | 1055 | d2i_PKCS8PrivateKey_bio.3 i2d_PKCS8PrivateKey_nid_fp.3 \ |
1040 | d2i_PKCS8PrivateKey.3 i2d_PKCS8PrivateKey_nid_fp.3 \ | ||
1041 | d2i_RSAPublicKey.3 d2i_Netscape_RSA.3 \ | 1056 | d2i_RSAPublicKey.3 d2i_Netscape_RSA.3 \ |
1042 | d2i_RSAPublicKey.3 d2i_RSAPrivateKey.3 \ | 1057 | d2i_RSAPublicKey.3 d2i_RSAPrivateKey.3 \ |
1043 | d2i_RSAPublicKey.3 i2d_Netscape_RSA.3 \ | 1058 | d2i_RSAPublicKey.3 i2d_Netscape_RSA.3 \ |
@@ -1060,24 +1075,9 @@ MLINKS+=\ | |||
1060 | d2i_X509_REQ.3 i2d_X509_REQ.3 \ | 1075 | d2i_X509_REQ.3 i2d_X509_REQ.3 \ |
1061 | d2i_X509_REQ.3 i2d_X509_REQ_bio.3 \ | 1076 | d2i_X509_REQ.3 i2d_X509_REQ_bio.3 \ |
1062 | d2i_X509_REQ.3 i2d_X509_REQ_fp.3 \ | 1077 | d2i_X509_REQ.3 i2d_X509_REQ_fp.3 \ |
1063 | ecdsa.3 ECDSA_OpenSSL.3 \ | 1078 | des_read_pw.3 des_read_2passwords.3 \ |
1064 | ecdsa.3 ECDSA_SIG_free.3 \ | 1079 | des_read_pw.3 des_read_password.3 \ |
1065 | ecdsa.3 ECDSA_SIG_new.3 \ | 1080 | des_read_pw.3 des_read_pw_string.3 \ |
1066 | ecdsa.3 ECDSA_do_sign.3 \ | ||
1067 | ecdsa.3 ECDSA_do_sign_ex.3 \ | ||
1068 | ecdsa.3 ECDSA_do_verify.3 \ | ||
1069 | ecdsa.3 ECDSA_get_default_method.3 \ | ||
1070 | ecdsa.3 ECDSA_get_ex_data.3 \ | ||
1071 | ecdsa.3 ECDSA_get_ex_new_index.3 \ | ||
1072 | ecdsa.3 ECDSA_set_default_method.3 \ | ||
1073 | ecdsa.3 ECDSA_set_ex_data.3 \ | ||
1074 | ecdsa.3 ECDSA_set_method.3 \ | ||
1075 | ecdsa.3 ECDSA_sign.3 \ | ||
1076 | ecdsa.3 ECDSA_sign_ex.3 \ | ||
1077 | ecdsa.3 ECDSA_sign_setup.3 \ | ||
1078 | ecdsa.3 ECDSA_verify.3 \ | ||
1079 | ecdsa.3 d2i_ECDSA_SIG.3 \ | ||
1080 | ecdsa.3 i2d_ECDSA_SIG.3 \ | ||
1081 | engine.3 ENGINE_add.3 \ | 1081 | engine.3 ENGINE_add.3 \ |
1082 | engine.3 ENGINE_by_id.3 \ | 1082 | engine.3 ENGINE_by_id.3 \ |
1083 | engine.3 ENGINE_finish.3 \ | 1083 | engine.3 ENGINE_finish.3 \ |
@@ -1088,47 +1088,41 @@ MLINKS+=\ | |||
1088 | engine.3 ENGINE_init.3 \ | 1088 | engine.3 ENGINE_init.3 \ |
1089 | engine.3 ENGINE_load_builtin_engines.3 \ | 1089 | engine.3 ENGINE_load_builtin_engines.3 \ |
1090 | engine.3 ENGINE_remove.3 \ | 1090 | engine.3 ENGINE_remove.3 \ |
1091 | lh_new.3 lh_delete.3 \ | ||
1092 | lh_new.3 lh_doall.3 \ | ||
1093 | lh_new.3 lh_doall_arg.3 \ | ||
1094 | lh_new.3 lh_error.3 \ | ||
1095 | lh_new.3 lh_free.3 \ | ||
1096 | lh_new.3 lh_insert.3 \ | ||
1097 | lh_new.3 lh_retrieve.3 \ | ||
1091 | lh_stats.3 lh_node_stats.3 \ | 1098 | lh_stats.3 lh_node_stats.3 \ |
1092 | lh_stats.3 lh_node_stats_bio.3 \ | 1099 | lh_stats.3 lh_node_stats_bio.3 \ |
1093 | lh_stats.3 lh_node_usage_stats.3 \ | 1100 | lh_stats.3 lh_node_usage_stats.3 \ |
1094 | lh_stats.3 lh_node_usage_stats_bio.3 \ | 1101 | lh_stats.3 lh_node_usage_stats_bio.3 \ |
1095 | lh_stats.3 lh_stats_bio.3 \ | 1102 | lh_stats.3 lh_stats_bio.3 \ |
1096 | lhash.3 lh_delete.3 \ | 1103 | ui_new.3 UI_OpenSSL.3 \ |
1097 | lhash.3 lh_doall.3 \ | 1104 | ui_new.3 UI_add_error_string.3 \ |
1098 | lhash.3 lh_doall_arg.3 \ | 1105 | ui_new.3 UI_add_info_string.3 \ |
1099 | lhash.3 lh_error.3 \ | 1106 | ui_new.3 UI_add_input_boolean.3 \ |
1100 | lhash.3 lh_free.3 \ | 1107 | ui_new.3 UI_add_input_string.3 \ |
1101 | lhash.3 lh_insert.3 \ | 1108 | ui_new.3 UI_add_user_data.3 \ |
1102 | lhash.3 lh_new.3 \ | 1109 | ui_new.3 UI_add_verify_string.3 \ |
1103 | lhash.3 lh_retrieve.3 \ | 1110 | ui_new.3 UI_construct_prompt.3 \ |
1104 | ui.3 UI_OpenSSL.3 \ | 1111 | ui_new.3 UI_ctrl.3 \ |
1105 | ui.3 UI_add_error_string.3 \ | 1112 | ui_new.3 UI_dup_error_string.3 \ |
1106 | ui.3 UI_add_info_string.3 \ | 1113 | ui_new.3 UI_dup_info_string.3 \ |
1107 | ui.3 UI_add_input_boolean.3 \ | 1114 | ui_new.3 UI_dup_input_boolean.3 \ |
1108 | ui.3 UI_add_input_string.3 \ | 1115 | ui_new.3 UI_dup_input_string.3 \ |
1109 | ui.3 UI_add_user_data.3 \ | 1116 | ui_new.3 UI_dup_verify_string.3 \ |
1110 | ui.3 UI_add_verify_string.3 \ | 1117 | ui_new.3 UI_free.3 \ |
1111 | ui.3 UI_construct_prompt.3 \ | 1118 | ui_new.3 UI_get0_result.3 \ |
1112 | ui.3 UI_ctrl.3 \ | 1119 | ui_new.3 UI_get0_user_data.3 \ |
1113 | ui.3 UI_dup_error_string.3 \ | 1120 | ui_new.3 UI_get_default_method.3 \ |
1114 | ui.3 UI_dup_info_string.3 \ | 1121 | ui_new.3 UI_get_method.3 \ |
1115 | ui.3 UI_dup_input_boolean.3 \ | 1122 | ui_new.3 UI_new_method.3 \ |
1116 | ui.3 UI_dup_input_string.3 \ | 1123 | ui_new.3 UI_process.3 \ |
1117 | ui.3 UI_dup_verify_string.3 \ | 1124 | ui_new.3 UI_set_default_method.3 \ |
1118 | ui.3 UI_free.3 \ | 1125 | ui_new.3 UI_set_method.3 |
1119 | ui.3 UI_get0_result.3 \ | ||
1120 | ui.3 UI_get0_user_data.3 \ | ||
1121 | ui.3 UI_get_default_method.3 \ | ||
1122 | ui.3 UI_get_method.3 \ | ||
1123 | ui.3 UI_new.3 \ | ||
1124 | ui.3 UI_new_method.3 \ | ||
1125 | ui.3 UI_process.3 \ | ||
1126 | ui.3 UI_set_default_method.3 \ | ||
1127 | ui.3 UI_set_method.3 \ | ||
1128 | ui_compat.3 des_read_2passwords.3 \ | ||
1129 | ui_compat.3 des_read_password.3 \ | ||
1130 | ui_compat.3 des_read_pw.3 \ | ||
1131 | ui_compat.3 des_read_pw_string.3 | ||
1132 | 1126 | ||
1133 | .include <bsd.man.mk> | 1127 | .include <bsd.man.mk> |
1134 | .else | 1128 | .else |
diff --git a/src/lib/libcrypto/man/bn_dump.3 b/src/lib/libcrypto/man/bn_dump.3 new file mode 100644 index 0000000000..2f1bda9bb5 --- /dev/null +++ b/src/lib/libcrypto/man/bn_dump.3 | |||
@@ -0,0 +1,713 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt BN_DUMP 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm bn_mul_words , | ||
6 | .Nm bn_mul_add_words , | ||
7 | .Nm bn_sqr_words , | ||
8 | .Nm bn_div_words , | ||
9 | .Nm bn_add_words , | ||
10 | .Nm bn_sub_words , | ||
11 | .Nm bn_mul_comba4 , | ||
12 | .Nm bn_mul_comba8 , | ||
13 | .Nm bn_sqr_comba4 , | ||
14 | .Nm bn_sqr_comba8 , | ||
15 | .Nm bn_cmp_words , | ||
16 | .Nm bn_mul_normal , | ||
17 | .Nm bn_mul_low_normal , | ||
18 | .Nm bn_mul_recursive , | ||
19 | .Nm bn_mul_part_recursive , | ||
20 | .Nm bn_mul_low_recursive , | ||
21 | .Nm bn_mul_high , | ||
22 | .Nm bn_sqr_normal , | ||
23 | .Nm bn_sqr_recursive , | ||
24 | .Nm bn_expand , | ||
25 | .Nm bn_wexpand , | ||
26 | .Nm bn_expand2 , | ||
27 | .Nm bn_fix_top , | ||
28 | .Nm bn_check_top , | ||
29 | .Nm bn_print , | ||
30 | .Nm bn_dump , | ||
31 | .Nm bn_set_max , | ||
32 | .Nm bn_set_high , | ||
33 | .Nm bn_set_low , | ||
34 | .Nm sqr | ||
35 | .Nd BIGNUM library internal functions | ||
36 | .Sh SYNOPSIS | ||
37 | .In openssl/bn.h | ||
38 | .Ft BN_ULONG | ||
39 | .Fo bn_mul_words | ||
40 | .Fa "BN_ULONG *rp" | ||
41 | .Fa "BN_ULONG *ap" | ||
42 | .Fa "int num" | ||
43 | .Fa "BN_ULONG w" | ||
44 | .Fc | ||
45 | .Ft BN_ULONG | ||
46 | .Fo bn_mul_add_words | ||
47 | .Fa "BN_ULONG *rp" | ||
48 | .Fa "BN_ULONG *ap" | ||
49 | .Fa "int num" | ||
50 | .Fa "BN_ULONG w" | ||
51 | .Fc | ||
52 | .Ft void | ||
53 | .Fo bn_sqr_words | ||
54 | .Fa "BN_ULONG *rp" | ||
55 | .Fa "BN_ULONG *ap" | ||
56 | .Fa "int num" | ||
57 | .Fc | ||
58 | .Ft BN_ULONG | ||
59 | .Fo bn_div_words | ||
60 | .Fa "BN_ULONG h" | ||
61 | .Fa "BN_ULONG l" | ||
62 | .Fa "BN_ULONG d" | ||
63 | .Fc | ||
64 | .Ft BN_ULONG | ||
65 | .Fo bn_add_words | ||
66 | .Fa "BN_ULONG *rp" | ||
67 | .Fa "BN_ULONG *ap" | ||
68 | .Fa "BN_ULONG *bp" | ||
69 | .Fa "int num" | ||
70 | .Fc | ||
71 | .Ft BN_ULONG | ||
72 | .Fo bn_sub_words | ||
73 | .Fa "BN_ULONG *rp" | ||
74 | .Fa "BN_ULONG *ap" | ||
75 | .Fa "BN_ULONG *bp" | ||
76 | .Fa "int num" | ||
77 | .Fc | ||
78 | .Ft void | ||
79 | .Fo bn_mul_comba4 | ||
80 | .Fa "BN_ULONG *r" | ||
81 | .Fa "BN_ULONG *a" | ||
82 | .Fa "BN_ULONG *b" | ||
83 | .Fc | ||
84 | .Ft void | ||
85 | .Fo bn_mul_comba8 | ||
86 | .Fa "BN_ULONG *r" | ||
87 | .Fa "BN_ULONG *a" | ||
88 | .Fa "BN_ULONG *b" | ||
89 | .Fc | ||
90 | .Ft void | ||
91 | .Fo bn_sqr_comba4 | ||
92 | .Fa "BN_ULONG *r" | ||
93 | .Fa "BN_ULONG *a" | ||
94 | .Fc | ||
95 | .Ft void | ||
96 | .Fo bn_sqr_comba8 | ||
97 | .Fa "BN_ULONG *r" | ||
98 | .Fa "BN_ULONG *a" | ||
99 | .Fc | ||
100 | .Ft int | ||
101 | .Fo bn_cmp_words | ||
102 | .Fa "BN_ULONG *a" | ||
103 | .Fa "BN_ULONG *b" | ||
104 | .Fa "int n" | ||
105 | .Fc | ||
106 | .Ft void | ||
107 | .Fo bn_mul_normal | ||
108 | .Fa "BN_ULONG *r" | ||
109 | .Fa "BN_ULONG *a" | ||
110 | .Fa "int na" | ||
111 | .Fa "BN_ULONG *b" | ||
112 | .Fa "int nb" | ||
113 | .Fc | ||
114 | .Ft void | ||
115 | .Fo bn_mul_low_normal | ||
116 | .Fa "BN_ULONG *r" | ||
117 | .Fa "BN_ULONG *a" | ||
118 | .Fa "BN_ULONG *b" | ||
119 | .Fa "int n" | ||
120 | .Fc | ||
121 | .Ft void | ||
122 | .Fo bn_mul_recursive | ||
123 | .Fa "BN_ULONG *r" | ||
124 | .Fa "BN_ULONG *a" | ||
125 | .Fa "BN_ULONG *b" | ||
126 | .Fa "int n2" | ||
127 | .Fa "int dna" | ||
128 | .Fa "int dnb" | ||
129 | .Fa "BN_ULONG *tmp" | ||
130 | .Fc | ||
131 | .Ft void | ||
132 | .Fo bn_mul_part_recursive | ||
133 | .Fa "BN_ULONG *r" | ||
134 | .Fa "BN_ULONG *a" | ||
135 | .Fa "BN_ULONG *b" | ||
136 | .Fa "int n" | ||
137 | .Fa "int tna" | ||
138 | .Fa "int tnb" | ||
139 | .Fa "BN_ULONG *tmp" | ||
140 | .Fc | ||
141 | .Ft void | ||
142 | .Fo bn_mul_low_recursive | ||
143 | .Fa "BN_ULONG *r" | ||
144 | .Fa "BN_ULONG *a" | ||
145 | .Fa "BN_ULONG *b" | ||
146 | .Fa "int n2" | ||
147 | .Fa "BN_ULONG *tmp" | ||
148 | .Fc | ||
149 | .Ft void | ||
150 | .Fo bn_mul_high | ||
151 | .Fa "BN_ULONG *r" | ||
152 | .Fa "BN_ULONG *a" | ||
153 | .Fa "BN_ULONG *b" | ||
154 | .Fa "BN_ULONG *l" | ||
155 | .Fa "int n2" | ||
156 | .Fa "BN_ULONG *tmp" | ||
157 | .Fc | ||
158 | .Ft void | ||
159 | .Fo bn_sqr_normal | ||
160 | .Fa "BN_ULONG *r" | ||
161 | .Fa "BN_ULONG *a" | ||
162 | .Fa "int n" | ||
163 | .Fa "BN_ULONG *tmp" | ||
164 | .Fc | ||
165 | .Ft void | ||
166 | .Fo bn_sqr_recursive | ||
167 | .Fa "BN_ULONG *r" | ||
168 | .Fa "BN_ULONG *a" | ||
169 | .Fa "int n2" | ||
170 | .Fa "BN_ULONG *tmp" | ||
171 | .Fc | ||
172 | .Ft void | ||
173 | .Fo mul | ||
174 | .Fa "BN_ULONG r" | ||
175 | .Fa "BN_ULONG a" | ||
176 | .Fa "BN_ULONG w" | ||
177 | .Fa "BN_ULONG c" | ||
178 | .Fc | ||
179 | .Ft void | ||
180 | .Fo mul_add | ||
181 | .Fa "BN_ULONG r" | ||
182 | .Fa "BN_ULONG a" | ||
183 | .Fa "BN_ULONG w" | ||
184 | .Fa "BN_ULONG c" | ||
185 | .Fc | ||
186 | .Ft void | ||
187 | .Fo sqr | ||
188 | .Fa "BN_ULONG r0" | ||
189 | .Fa "BN_ULONG r1" | ||
190 | .Fa "BN_ULONG a" | ||
191 | .Fc | ||
192 | .Ft BIGNUM * | ||
193 | .Fo bn_expand | ||
194 | .Fa "BIGNUM *a" | ||
195 | .Fa "int bits" | ||
196 | .Fc | ||
197 | .Ft BIGNUM * | ||
198 | .Fo bn_wexpand | ||
199 | .Fa "BIGNUM *a" | ||
200 | .Fa "int n" | ||
201 | .Fc | ||
202 | .Ft BIGNUM * | ||
203 | .Fo bn_expand2 | ||
204 | .Fa "BIGNUM *a" | ||
205 | .Fa "int n" | ||
206 | .Fc | ||
207 | .Ft void | ||
208 | .Fo bn_fix_top | ||
209 | .Fa "BIGNUM *a" | ||
210 | .Fc | ||
211 | .Ft void | ||
212 | .Fo bn_check_top | ||
213 | .Fa "BIGNUM *a" | ||
214 | .Fc | ||
215 | .Ft void | ||
216 | .Fo bn_print | ||
217 | .Fa "BIGNUM *a" | ||
218 | .Fc | ||
219 | .Ft void | ||
220 | .Fo bn_dump | ||
221 | .Fa "BN_ULONG *d" | ||
222 | .Fa "int n" | ||
223 | .Fc | ||
224 | .Ft void | ||
225 | .Fo bn_set_max | ||
226 | .Fa "BIGNUM *a" | ||
227 | .Fc | ||
228 | .Ft void | ||
229 | .Fo bn_set_high | ||
230 | .Fa "BIGNUM *r" | ||
231 | .Fa "BIGNUM *a" | ||
232 | .Fa "int n" | ||
233 | .Fc | ||
234 | .Ft void | ||
235 | .Fo bn_set_low | ||
236 | .Fa "BIGNUM *r" | ||
237 | .Fa "BIGNUM *a" | ||
238 | .Fa "int n" | ||
239 | .Fc | ||
240 | .Sh DESCRIPTION | ||
241 | This page documents the internal functions used by the OpenSSL | ||
242 | .Vt BIGNUM | ||
243 | implementation. | ||
244 | They are described here to facilitate debugging and extending the | ||
245 | library. | ||
246 | They are | ||
247 | .Em not | ||
248 | to be used by applications. | ||
249 | .Ss The BIGNUM structure | ||
250 | .Bd -literal | ||
251 | typedef struct bignum_st BIGNUM; | ||
252 | |||
253 | struct bignum_st { | ||
254 | BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */ | ||
255 | int top; /* Index of last used d +1. */ | ||
256 | /* The next are internal book keeping for bn_expand. */ | ||
257 | int dmax; /* Size of the d array. */ | ||
258 | int neg; /* one if the number is negative */ | ||
259 | int flags; | ||
260 | }; | ||
261 | .Ed | ||
262 | .Pp | ||
263 | The integer value is stored in | ||
264 | .Fa d , | ||
265 | a | ||
266 | .Xr malloc 3 Ap ed | ||
267 | array of words | ||
268 | .Pq Vt BN_ULONG , | ||
269 | least significant word first. | ||
270 | A | ||
271 | .Vt BN_ULONG | ||
272 | can be either 16, 32 or 64 bits in size, depending on the 'number of | ||
273 | bits' | ||
274 | .Pq Dv BITS2 | ||
275 | specified in | ||
276 | .In openssl/bn.h . | ||
277 | .Pp | ||
278 | .Fa dmax | ||
279 | is the size of the | ||
280 | .Fa d | ||
281 | array that has been allocated. | ||
282 | .Fa top | ||
283 | is the number of words being used, so for a value of 4, bn.d[0]=4 and | ||
284 | bn.top=1. | ||
285 | .Fa neg | ||
286 | is 1 if the number is negative. | ||
287 | When a | ||
288 | .Vt BIGNUM | ||
289 | is 0, the | ||
290 | .Fa d | ||
291 | field can be | ||
292 | .Dv NULL | ||
293 | and | ||
294 | .Fa top | ||
295 | == 0. | ||
296 | .Pp | ||
297 | .Fa flags | ||
298 | is a bit field of flags which are defined in | ||
299 | .In openssl/bn.h . | ||
300 | The flags begin with | ||
301 | .Dv BN_FLG_ . | ||
302 | The macros | ||
303 | .Fn BN_set_flags b n | ||
304 | and | ||
305 | .Fn BN_get_flags b n | ||
306 | exist to enable or fetch flag(s) | ||
307 | .Fa n | ||
308 | from a | ||
309 | .Vt BIGNUM | ||
310 | structure | ||
311 | .Fa b . | ||
312 | .Pp | ||
313 | Various routines in this library require the use of temporary | ||
314 | .Vt BIGNUM | ||
315 | variables during their execution. | ||
316 | Since dynamic memory allocation to create | ||
317 | .Vt BIGNUM Ns s | ||
318 | is rather expensive when used in conjunction with repeated subroutine | ||
319 | calls, the | ||
320 | .Vt BN_CTX | ||
321 | structure is used. | ||
322 | This structure contains BN_CTX_NUM | ||
323 | .Vt BIGNUM Ns s, | ||
324 | see | ||
325 | .Xr BN_CTX_start 3 . | ||
326 | .Ss Low-level arithmetic operations | ||
327 | These functions are implemented in C and for several platforms in | ||
328 | assembly language: | ||
329 | .Pp | ||
330 | .Fn bn_mul_words rp ap num w | ||
331 | operates on the | ||
332 | .Fa num | ||
333 | word arrays | ||
334 | .Fa rp | ||
335 | and | ||
336 | .Fa ap . | ||
337 | It computes | ||
338 | .Fa ap | ||
339 | * | ||
340 | .Fa w , | ||
341 | places the result in | ||
342 | .Fa rp , | ||
343 | and returns the high word (carry). | ||
344 | .Pp | ||
345 | .Fn bn_mul_add_words rp ap num w | ||
346 | operates on the | ||
347 | .Fa num | ||
348 | word arrays | ||
349 | .Fa rp | ||
350 | and | ||
351 | .Fa ap . | ||
352 | It computes | ||
353 | .Fa ap | ||
354 | * | ||
355 | .Fa w | ||
356 | + | ||
357 | .Fa rp , | ||
358 | places the result in | ||
359 | .Fa rp , | ||
360 | and returns the high word (carry). | ||
361 | .Pp | ||
362 | .Fn bn_sqr_words rp ap num | ||
363 | operates on the | ||
364 | .Fa num | ||
365 | word array | ||
366 | .Fa ap | ||
367 | and the | ||
368 | .Pf 2* Fa num | ||
369 | word array | ||
370 | .Fa ap . | ||
371 | It computes | ||
372 | .Fa ap | ||
373 | * | ||
374 | .Fa ap | ||
375 | word-wise, and places the low and high bytes of the result in | ||
376 | .Fa rp . | ||
377 | .Pp | ||
378 | .Fn bn_div_words h l d | ||
379 | divides the two word number | ||
380 | .Pq Fa h , Fa l | ||
381 | by | ||
382 | .Fa d | ||
383 | and returns the result. | ||
384 | .Pp | ||
385 | .Fn bn_add_words rp ap bp num | ||
386 | operates on the | ||
387 | .Fa num | ||
388 | word arrays | ||
389 | .Fa ap , | ||
390 | .Fa bp | ||
391 | and | ||
392 | .Fa rp . | ||
393 | It computes | ||
394 | .Fa ap | ||
395 | + | ||
396 | .Fa bp , | ||
397 | places the result in | ||
398 | .Fa rp , | ||
399 | and returns the high word (carry). | ||
400 | .Pp | ||
401 | .Fn bn_sub_words rp ap bp num | ||
402 | operates on the | ||
403 | .Fa num | ||
404 | word arrays | ||
405 | .Fa ap , | ||
406 | .Fa bp | ||
407 | and | ||
408 | .Fa rp . | ||
409 | It computes | ||
410 | .Fa ap | ||
411 | - | ||
412 | .Fa bp , | ||
413 | places the result in | ||
414 | .Fa rp , | ||
415 | and returns the carry (1 if | ||
416 | .Fa bp | ||
417 | \(ra | ||
418 | .Fa ap , | ||
419 | 0 otherwise). | ||
420 | .Pp | ||
421 | .Fn bn_mul_comba4 r a b | ||
422 | operates on the 4 word arrays | ||
423 | .Fa a | ||
424 | and | ||
425 | .Fa b | ||
426 | and the 8 word array | ||
427 | .Fa r . | ||
428 | It computes | ||
429 | .Fa a Ns * Ns Fa b | ||
430 | and places the result in | ||
431 | .Fa r . | ||
432 | .Pp | ||
433 | .Fn bn_mul_comba8 r a b | ||
434 | operates on the 8 word arrays | ||
435 | .Fa a | ||
436 | and | ||
437 | .Fa b | ||
438 | and the 16 word array | ||
439 | .Fa r . | ||
440 | It computes | ||
441 | .Fa a Ns * Ns Fa b | ||
442 | and places the result in | ||
443 | .Fa r . | ||
444 | .Pp | ||
445 | .Fn bn_sqr_comba4 r a b | ||
446 | operates on the 4 word arrays | ||
447 | .Fa a | ||
448 | and | ||
449 | .Fa b | ||
450 | and the 8 word array | ||
451 | .Fa r . | ||
452 | .Pp | ||
453 | .Fn bn_sqr_comba8 r a b | ||
454 | operates on the 8 word arrays | ||
455 | .Fa a | ||
456 | and | ||
457 | .Fa b | ||
458 | and the 16 word array | ||
459 | .Fa r . | ||
460 | .Pp | ||
461 | The following functions are implemented in C: | ||
462 | .Pp | ||
463 | .Fn bn_cmp_words a b n | ||
464 | operates on the | ||
465 | .Fa n | ||
466 | word arrays | ||
467 | .Fa a | ||
468 | and | ||
469 | .Fa b . | ||
470 | It returns 1, 0 and -1 if | ||
471 | .Fa a | ||
472 | is greater than, equal and less than | ||
473 | .Fa b . | ||
474 | .Pp | ||
475 | .Fn bn_mul_normal r a na b nb | ||
476 | operates on the | ||
477 | .Fa na | ||
478 | word array | ||
479 | .Fa a , | ||
480 | the | ||
481 | .Fa nb | ||
482 | word array | ||
483 | .Fa b | ||
484 | and the | ||
485 | .Fa na Ns + Ns Fa nb | ||
486 | word array | ||
487 | .Fa r . | ||
488 | It computes | ||
489 | .Fa a Ns * Ns Fa b | ||
490 | and places the result in | ||
491 | .Fa r . | ||
492 | .Pp | ||
493 | .Fn bn_mul_low_normal r a b n | ||
494 | operates on the | ||
495 | .Fa n | ||
496 | word arrays | ||
497 | .Fa r , | ||
498 | .Fa a | ||
499 | and | ||
500 | .Fa b . | ||
501 | It computes the | ||
502 | .Fa n | ||
503 | low words of | ||
504 | .Fa a Ns * Ns Fa b | ||
505 | and places the result in | ||
506 | .Fa r . | ||
507 | .Pp | ||
508 | .Fn bn_mul_recursive r a b n2 dna dnb t | ||
509 | operates on the word arrays | ||
510 | .Fa a | ||
511 | and | ||
512 | .Fa b | ||
513 | of length | ||
514 | .Fa n2 Ns + Ns Fa dna | ||
515 | and | ||
516 | .Fa n2 Ns + Ns Fa dnb | ||
517 | .Pf ( Fa dna | ||
518 | and | ||
519 | .Fa dnb | ||
520 | are currently allowed to be 0 or negative) and the | ||
521 | .Pf 2* Fa n2 | ||
522 | word arrays | ||
523 | .Fa r | ||
524 | and | ||
525 | .Sy t . | ||
526 | .Fa n2 | ||
527 | must be a power of 2. | ||
528 | It computes | ||
529 | .Fa a Ns * Ns Fa b | ||
530 | and places the result in | ||
531 | .Fa r . | ||
532 | .Pp | ||
533 | .Fn bn_mul_part_recursive r a b n tna tnb tmp | ||
534 | operates on the word arrays | ||
535 | .Fa a | ||
536 | and | ||
537 | .Fa b | ||
538 | of length | ||
539 | .Fa n Ns + Ns Fa tna | ||
540 | and | ||
541 | .Fa n Ns + Ns Fa tnb | ||
542 | and the | ||
543 | .Pf 4* Fa n | ||
544 | word arrays | ||
545 | .Fa r | ||
546 | and | ||
547 | .Fa tmp . | ||
548 | .Pp | ||
549 | .Fn bn_mul_low_recursive r a b n2 tmp | ||
550 | operates on the | ||
551 | .Fa n2 | ||
552 | word arrays | ||
553 | .Fa r | ||
554 | and | ||
555 | .Fa tmp | ||
556 | and the | ||
557 | .Fa n2 Ns /2 | ||
558 | word arrays | ||
559 | .Fa a | ||
560 | and | ||
561 | .Fa b . | ||
562 | .Pp | ||
563 | .Fn bn_mul_high r a b l n2 tmp | ||
564 | operates on the | ||
565 | .Fa n2 | ||
566 | word arrays | ||
567 | .Fa r , | ||
568 | .Fa a , | ||
569 | .Fa b | ||
570 | and | ||
571 | .Fa l | ||
572 | (?) and the | ||
573 | .Pf 3* Fa n2 | ||
574 | word array | ||
575 | .Fa tmp . | ||
576 | .Pp | ||
577 | .Xr BN_mul 3 | ||
578 | calls | ||
579 | .Fn bn_mul_normal , | ||
580 | or an optimized implementation if the factors have the same size: | ||
581 | .Fn bn_mul_comba8 | ||
582 | is used if they are 8 words long, | ||
583 | .Fn bn_mul_recursive | ||
584 | if they are larger than | ||
585 | .Dv BN_MULL_SIZE_NORMAL | ||
586 | and the size is an exact multiple of the word size, and | ||
587 | .Fn bn_mul_part_recursive | ||
588 | for others that are larger than | ||
589 | .Dv BN_MULL_SIZE_NORMAL . | ||
590 | .Pp | ||
591 | .Fn bn_sqr_normal r a n tmp | ||
592 | operates on the | ||
593 | .Fa n | ||
594 | word array | ||
595 | .Fa a | ||
596 | and the | ||
597 | .Pf 2* Fa n | ||
598 | word arrays | ||
599 | .Fa tmp | ||
600 | and | ||
601 | .Fa r . | ||
602 | .Pp | ||
603 | The implementations use the following macros which, depending on the | ||
604 | architecture, may use | ||
605 | .Vt long long | ||
606 | C operations or inline assembler. | ||
607 | They are defined in | ||
608 | .Pa bn_lcl.h . | ||
609 | .Pp | ||
610 | .Fn mul r a w c | ||
611 | computes | ||
612 | .Fa w Ns * Ns Fa a Ns + Ns Fa c | ||
613 | and places the low word of the result in | ||
614 | .Fa r | ||
615 | and the high word in | ||
616 | .Fa c . | ||
617 | .Pp | ||
618 | .Fn mul_add r a w c | ||
619 | computes | ||
620 | .Fa w Ns * Ns Fa a Ns + Ns Fa r Ns + Ns Fa c | ||
621 | and places the low word of the result in | ||
622 | .Fa r | ||
623 | and the high word in | ||
624 | .Fa c . | ||
625 | .Pp | ||
626 | .Fn sqr r0 r1 a | ||
627 | computes | ||
628 | .Fa a Ns * Ns Fa a | ||
629 | and places the low word of the result in | ||
630 | .Fa r0 | ||
631 | and the high word in | ||
632 | .Fa r1 . | ||
633 | .Ss Size changes | ||
634 | .Fn bn_expand | ||
635 | ensures that | ||
636 | .Fa b | ||
637 | has enough space for a | ||
638 | .Fa bits | ||
639 | bit number. | ||
640 | .Fn bn_wexpand | ||
641 | ensures that | ||
642 | .Fa b | ||
643 | has enough space for an | ||
644 | .Fa n | ||
645 | word number. | ||
646 | If the number has to be expanded, both macros call | ||
647 | .Fn bn_expand2 , | ||
648 | which allocates a new | ||
649 | .Fa d | ||
650 | array and copies the data. | ||
651 | They return | ||
652 | .Dv NULL | ||
653 | on error, | ||
654 | .Fa b | ||
655 | otherwise. | ||
656 | .Pp | ||
657 | The | ||
658 | .Fn bn_fix_top | ||
659 | macro reduces | ||
660 | .Fa a Ns -> Ns Fa top | ||
661 | to point to the most significant non-zero word plus one when | ||
662 | .Fa a | ||
663 | has shrunk. | ||
664 | .Ss Debugging | ||
665 | .Fn bn_check_top | ||
666 | verifies that | ||
667 | .Ql ((a)-\(ratop \(ra= 0 && (a)-\(ratop \(la= (a)-\(radmax) . | ||
668 | A violation will cause the program to abort. | ||
669 | .Pp | ||
670 | .Fn bn_print | ||
671 | prints | ||
672 | .Fa a | ||
673 | to | ||
674 | .Dv stderr . | ||
675 | .Fn bn_dump | ||
676 | prints | ||
677 | .Fa n | ||
678 | words at | ||
679 | .Fa d | ||
680 | (in reverse order, i.e. | ||
681 | most significant word first) to | ||
682 | .Dv stderr . | ||
683 | .Pp | ||
684 | .Fn bn_set_max | ||
685 | makes | ||
686 | .Fa a | ||
687 | a static number with a | ||
688 | .Fa dmax | ||
689 | of its current size. | ||
690 | This is used by | ||
691 | .Fn bn_set_low | ||
692 | and | ||
693 | .Fn bn_set_high | ||
694 | to make | ||
695 | .Fa r | ||
696 | a read-only | ||
697 | .Vt BIGNUM | ||
698 | that contains the | ||
699 | .Fa n | ||
700 | low or high words of | ||
701 | .Fa a . | ||
702 | .Pp | ||
703 | If | ||
704 | .Dv BN_DEBUG | ||
705 | is not defined, | ||
706 | .Fn bn_check_top , | ||
707 | .Fn bn_print , | ||
708 | .Fn bn_dump | ||
709 | and | ||
710 | .Fn bn_set_max | ||
711 | are defined as empty macros. | ||
712 | .Sh SEE ALSO | ||
713 | .Xr bn 3 | ||
diff --git a/src/lib/libcrypto/man/d2i_PKCS8PrivateKey_bio.3 b/src/lib/libcrypto/man/d2i_PKCS8PrivateKey_bio.3 new file mode 100644 index 0000000000..9eb5fadfab --- /dev/null +++ b/src/lib/libcrypto/man/d2i_PKCS8PrivateKey_bio.3 | |||
@@ -0,0 +1,97 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt D2I_PKCS8PRIVATEKEY_BIO 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm d2i_PKCS8PrivateKey_bio , | ||
6 | .Nm d2i_PKCS8PrivateKey_fp , | ||
7 | .Nm i2d_PKCS8PrivateKey_bio , | ||
8 | .Nm i2d_PKCS8PrivateKey_fp , | ||
9 | .Nm i2d_PKCS8PrivateKey_nid_bio , | ||
10 | .Nm i2d_PKCS8PrivateKey_nid_fp | ||
11 | .Nd PKCS#8 format private key functions | ||
12 | .Sh SYNOPSIS | ||
13 | .In openssl/evp.h | ||
14 | .Ft EVP_PKEY * | ||
15 | .Fo d2i_PKCS8PrivateKey_bio | ||
16 | .Fa "BIO *bp" | ||
17 | .Fa "EVP_PKEY **x" | ||
18 | .Fa "pem_password_cb *cb" | ||
19 | .Fa "void *u" | ||
20 | .Fc | ||
21 | .Ft EVP_PKEY * | ||
22 | .Fo d2i_PKCS8PrivateKey_fp | ||
23 | .Fa "FILE *fp" | ||
24 | .Fa "EVP_PKEY **x" | ||
25 | .Fa "pem_password_cb *cb" | ||
26 | .Fa "void *u" | ||
27 | .Fc | ||
28 | .Ft int | ||
29 | .Fo i2d_PKCS8PrivateKey_bio | ||
30 | .Fa "BIO *bp" | ||
31 | .Fa "EVP_PKEY *x" | ||
32 | .Fa "const EVP_CIPHER *enc" | ||
33 | .Fa "char *kstr" | ||
34 | .Fa "int klen" | ||
35 | .Fa "pem_password_cb *cb" | ||
36 | .Fa "void *u" | ||
37 | .Fc | ||
38 | .Ft int | ||
39 | .Fo i2d_PKCS8PrivateKey_fp | ||
40 | .Fa "FILE *fp" | ||
41 | .Fa "EVP_PKEY *x" | ||
42 | .Fa "const EVP_CIPHER *enc" | ||
43 | .Fa "char *kstr" | ||
44 | .Fa "int klen" | ||
45 | .Fa "pem_password_cb *cb" | ||
46 | .Fa "void *u" | ||
47 | .Fc | ||
48 | .Ft int | ||
49 | .Fo i2d_PKCS8PrivateKey_nid_bio | ||
50 | .Fa "BIO *bp" | ||
51 | .Fa "EVP_PKEY *x" | ||
52 | .Fa "int nid" | ||
53 | .Fa "char *kstr" | ||
54 | .Fa "int klen" | ||
55 | .Fa "pem_password_cb *cb" | ||
56 | .Fa "void *u" | ||
57 | .Fc | ||
58 | .Ft int | ||
59 | .Fo i2d_PKCS8PrivateKey_nid_fp | ||
60 | .Fa "FILE *fp" | ||
61 | .Fa "EVP_PKEY *x" | ||
62 | .Fa "int nid" | ||
63 | .Fa "char *kstr" | ||
64 | .Fa "int klen" | ||
65 | .Fa "pem_password_cb *cb" | ||
66 | .Fa "void *u" | ||
67 | .Fc | ||
68 | .Sh DESCRIPTION | ||
69 | The PKCS#8 functions encode and decode private keys in PKCS#8 format | ||
70 | using both PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption | ||
71 | algorithms. | ||
72 | .Pp | ||
73 | Other than the use of DER as opposed to PEM these functions are | ||
74 | identical to the corresponding | ||
75 | .Xr pem 3 | ||
76 | functions. | ||
77 | .Sh NOTES | ||
78 | Before using these functions, | ||
79 | .Xr OpenSSL_add_all_algorithms 3 | ||
80 | should be called to initialize the internal algorithm lookup tables. | ||
81 | Otherwise errors about unknown algorithms will occur if an attempt is | ||
82 | made to decrypt a private key. | ||
83 | .Pp | ||
84 | These functions are currently the only way to store encrypted private | ||
85 | keys using DER format. | ||
86 | .Pp | ||
87 | Currently all the functions use | ||
88 | .Vt BIO | ||
89 | or | ||
90 | .Vt FILE | ||
91 | pointers, there are no functions which work directly on memory: | ||
92 | this can be readily worked around by converting the buffers to | ||
93 | memory BIOs, see | ||
94 | .Xr BIO_s_mem 3 | ||
95 | for details. | ||
96 | .Sh SEE ALSO | ||
97 | .Xr pem 3 | ||
diff --git a/src/lib/libcrypto/man/des_read_pw.3 b/src/lib/libcrypto/man/des_read_pw.3 new file mode 100644 index 0000000000..e118b43793 --- /dev/null +++ b/src/lib/libcrypto/man/des_read_pw.3 | |||
@@ -0,0 +1,97 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt DES_READ_PW 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm des_read_password , | ||
6 | .Nm des_read_2passwords , | ||
7 | .Nm des_read_pw_string , | ||
8 | .Nm des_read_pw | ||
9 | .Nd Compatibility user interface functions | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/des_old.h | ||
12 | .Ft int | ||
13 | .Fo des_read_password | ||
14 | .Fa "DES_cblock *key" | ||
15 | .Fa "const char *prompt" | ||
16 | .Fa "int verify" | ||
17 | .Fc | ||
18 | .Ft int | ||
19 | .Fo des_read_2passwords | ||
20 | .Fa "DES_cblock *key1" | ||
21 | .Fa "DES_cblock *key2" | ||
22 | .Fa "const char *prompt" | ||
23 | .Fa "int verify" | ||
24 | .Fc | ||
25 | .Ft int | ||
26 | .Fo des_read_pw_string | ||
27 | .Fa "char *buf" | ||
28 | .Fa "int length" | ||
29 | .Fa "const char *prompt" | ||
30 | .Fa "int verify" | ||
31 | .Fc | ||
32 | .Ft int | ||
33 | .Fo des_read_pw | ||
34 | .Fa "char *buf" | ||
35 | .Fa "char *buff" | ||
36 | .Fa "int size" | ||
37 | .Fa "const char *prompt" | ||
38 | .Fa "int verify" | ||
39 | .Fc | ||
40 | .Sh DESCRIPTION | ||
41 | The DES library contained a few routines to prompt for passwords. | ||
42 | These aren't necessarily dependent on DES, and have therefore become | ||
43 | part of the UI compatibility library. | ||
44 | .Pp | ||
45 | .Fn des_read_pw | ||
46 | writes the string specified by | ||
47 | .Fa prompt | ||
48 | to standard output turns echo off and reads an input string from the | ||
49 | terminal. | ||
50 | The string is returned in | ||
51 | .Fa buf , | ||
52 | which must have space for at least | ||
53 | .Fa size | ||
54 | bytes. | ||
55 | If | ||
56 | .Fa verify | ||
57 | is set, the user is asked for the password twice and unless the two | ||
58 | copies match, an error is returned. | ||
59 | The second password is stored in | ||
60 | .Fa buff , | ||
61 | which must therefore also be at least | ||
62 | .Fa size | ||
63 | bytes. | ||
64 | A return code of -1 indicates a system error, 1 failure due to use | ||
65 | interaction, and 0 is success. | ||
66 | All other functions described here use | ||
67 | .Fn des_read_pw | ||
68 | to do the work. | ||
69 | .Pp | ||
70 | .Fn des_read_pw_string | ||
71 | is a variant of | ||
72 | .Fn des_read_pw | ||
73 | that provides a buffer for you if | ||
74 | .Fa verify | ||
75 | is set. | ||
76 | .Pp | ||
77 | .Fn des_read_password | ||
78 | calls | ||
79 | .Fn des_read_pw | ||
80 | and converts the password to a DES key by calling | ||
81 | .Xr DES_string_to_key 3 ; | ||
82 | .Fn des_read_2passwords | ||
83 | operates in the same way as | ||
84 | .Fn des_read_password | ||
85 | except that it generates two keys by using the | ||
86 | .Xr DES_string_to_2key 3 | ||
87 | function. | ||
88 | .Sh NOTES | ||
89 | .Fn des_read_pw_string | ||
90 | is available in the MIT Kerberos library as well, and is also available | ||
91 | under the name | ||
92 | .Xr EVP_read_pw_string 3 . | ||
93 | .Sh SEE ALSO | ||
94 | .Xr ui_new 3 | ||
95 | .Sh AUTHORS | ||
96 | .An Richard Levitte Aq Mt richard@levitte.org | ||
97 | for the OpenSSL project. | ||
diff --git a/src/lib/libcrypto/man/lh_new.3 b/src/lib/libcrypto/man/lh_new.3 new file mode 100644 index 0000000000..2779cf9202 --- /dev/null +++ b/src/lib/libcrypto/man/lh_new.3 | |||
@@ -0,0 +1,430 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt LH_NEW 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm lh_new , | ||
6 | .Nm lh_free , | ||
7 | .Nm lh_insert , | ||
8 | .Nm lh_delete , | ||
9 | .Nm lh_retrieve , | ||
10 | .Nm lh_doall , | ||
11 | .Nm lh_doall_arg , | ||
12 | .Nm lh_error | ||
13 | .Nd dynamic hash table | ||
14 | .Sh SYNOPSIS | ||
15 | .In openssl/lhash.h | ||
16 | .Fn DECLARE_LHASH_OF <type> | ||
17 | .Ft LHASH * | ||
18 | .Fn lh_<type>_new void | ||
19 | .Ft void | ||
20 | .Fo lh_<type>_free | ||
21 | .Fa "LHASH_OF(<type>) *table" | ||
22 | .Fc | ||
23 | .Ft <type> * | ||
24 | .Fo lh_<type>_insert | ||
25 | .Fa "LHASH_OF(<type>) *table" | ||
26 | .Fa "<type> *data" | ||
27 | .Fc | ||
28 | .Ft <type> * | ||
29 | .Fo lh_<type>_delete | ||
30 | .Fa "LHASH_OF(<type>) *table" | ||
31 | .Fa "<type> *data" | ||
32 | .Fc | ||
33 | .Ft <type> * | ||
34 | .Fo lh_<type>_retrieve | ||
35 | .Fa "LHASH_OF<type>) *table" | ||
36 | .Fa "<type> *data" | ||
37 | .Fc | ||
38 | .Ft void | ||
39 | .Fo lh_<type>_doall | ||
40 | .Fa "LHASH_OF(<type>) *table" | ||
41 | .Fa "LHASH_DOALL_FN_TYPE func" | ||
42 | .Fc | ||
43 | .Ft void | ||
44 | .Fo lh_<type>_doall_arg | ||
45 | .Fa "LHASH_OF(<type>) *table" | ||
46 | .Fa "LHASH_DOALL_ARG_FN_TYPE func" | ||
47 | .Fa "<type2>" | ||
48 | .Fa "<type2> *arg" | ||
49 | .Fc | ||
50 | .Ft int | ||
51 | .Fo lh_<type>_error | ||
52 | .Fa "LHASH_OF(<type>) *table" | ||
53 | .Fc | ||
54 | .Ft typedef int | ||
55 | .Fo (*LHASH_COMP_FN_TYPE) | ||
56 | .Fa "const void *" | ||
57 | .Fa "const void *" | ||
58 | .Fc | ||
59 | .Ft typedef unsigned long | ||
60 | .Fo (*LHASH_HASH_FN_TYPE) | ||
61 | .Fa "const void *" | ||
62 | .Fc | ||
63 | .Ft typedef void | ||
64 | .Fo (*LHASH_DOALL_FN_TYPE) | ||
65 | .Fa "const void *" | ||
66 | .Fc | ||
67 | .Ft typedef void | ||
68 | .Fo (*LHASH_DOALL_ARG_FN_TYPE) | ||
69 | .Fa "const void *" | ||
70 | .Fa "const void *" | ||
71 | .Fc | ||
72 | .Sh DESCRIPTION | ||
73 | This library implements type-checked dynamic hash tables. | ||
74 | The hash table entries can be arbitrary structures. | ||
75 | Usually they consist of key and value fields. | ||
76 | .Pp | ||
77 | .Fn lh_<type>_new | ||
78 | creates a new | ||
79 | .Vt LHASH_OF(<type>) | ||
80 | structure to store arbitrary data entries, and provides the hash and | ||
81 | compare callbacks to be used in organising the table's entries. | ||
82 | The hash callback takes a pointer to a table entry as its argument | ||
83 | and returns an unsigned long hash value for its key field. | ||
84 | The hash value is normally truncated to a power of 2, so make sure that | ||
85 | your hash function returns well mixed low order bits. | ||
86 | The compare callback takes two arguments (pointers to two hash table | ||
87 | entries), and returns 0 if their keys are equal, non-zero otherwise. | ||
88 | If your hash table will contain items of some particular type and the | ||
89 | hash and compare callbacks hash and compare these types, then the | ||
90 | .Fn DECLARE_LHASH_HASH_FN | ||
91 | and | ||
92 | .Fn IMPLEMENT_LHASH_COMP_FN | ||
93 | macros can be used to create callback wrappers of the prototypes | ||
94 | required by | ||
95 | .Fn lh_<type>_new . | ||
96 | These provide per-variable casts before calling the type-specific | ||
97 | callbacks written by the application author. | ||
98 | These macros, as well as those used for the doall callbacks, are | ||
99 | defined as; | ||
100 | .Bd -literal -offset 2n | ||
101 | #define DECLARE_LHASH_HASH_FN(name, o_type) \e | ||
102 | unsigned long name##_LHASH_HASH(const void *); | ||
103 | #define IMPLEMENT_LHASH_HASH_FN(name, o_type) \e | ||
104 | unsigned long name##_LHASH_HASH(const void *arg) { \e | ||
105 | const o_type *a = arg; \e | ||
106 | return name##_hash(a); } | ||
107 | #define LHASH_HASH_FN(name) name##_LHASH_HASH | ||
108 | |||
109 | #define DECLARE_LHASH_COMP_FN(name, o_type) \e | ||
110 | int name##_LHASH_COMP(const void *, const void *); | ||
111 | #define IMPLEMENT_LHASH_COMP_FN(name, o_type) \e | ||
112 | int name##_LHASH_COMP(const void *arg1, const void *arg2) { \e | ||
113 | const o_type *a = arg1; \e | ||
114 | const o_type *b = arg2; \e | ||
115 | return name##_cmp(a,b); } | ||
116 | #define LHASH_COMP_FN(name) name##_LHASH_COMP | ||
117 | |||
118 | #define DECLARE_LHASH_DOALL_FN(name, o_type) \e | ||
119 | void name##_LHASH_DOALL(void *); | ||
120 | #define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \e | ||
121 | void name##_LHASH_DOALL(void *arg) { \e | ||
122 | o_type *a = arg; \e | ||
123 | name##_doall(a); } | ||
124 | #define LHASH_DOALL_FN(name) name##_LHASH_DOALL | ||
125 | |||
126 | #define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \e | ||
127 | void name##_LHASH_DOALL_ARG(void *, void *); | ||
128 | #define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \e | ||
129 | void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \e | ||
130 | o_type *a = arg1; \e | ||
131 | a_type *b = arg2; \e | ||
132 | name##_doall_arg(a, b); } | ||
133 | #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG | ||
134 | .Ed | ||
135 | .Pp | ||
136 | An example of a hash table storing (pointers to) structures of type | ||
137 | \&'STUFF' could be defined as follows; | ||
138 | .Bd -literal -offset 2n | ||
139 | /* Calculate the hash value of 'tohash' (implemented elsewhere) */ | ||
140 | unsigned long STUFF_hash(const STUFF *tohash); | ||
141 | /* Order 'arg1' and 'arg2' (implemented elsewhere) */ | ||
142 | int stuff_cmp(const STUFF *arg1, const STUFF *arg2); | ||
143 | /* Create type-safe wrapper functions for use in the LHASH internals */ | ||
144 | static IMPLEMENT_LHASH_HASH_FN(stuff, STUFF); | ||
145 | static IMPLEMENT_LHASH_COMP_FN(stuff, STUFF); | ||
146 | /* ... */ | ||
147 | int main(int argc, char *argv[]) { | ||
148 | /* Create the new hash table using the hash/compare wrappers */ | ||
149 | LHASH_OF(STUFF) *hashtable = | ||
150 | lh_STUFF_new(LHASH_HASH_FN(STUFF_hash), | ||
151 | LHASH_COMP_FN(STUFF_cmp)); | ||
152 | /* ... */ | ||
153 | } | ||
154 | .Ed | ||
155 | .Pp | ||
156 | .Fn lh_<type>_free | ||
157 | frees the | ||
158 | .Vt LHASH_OF(<type>) | ||
159 | structure | ||
160 | .Fa table . | ||
161 | Allocated hash table entries will not be freed; consider using | ||
162 | .Fn lh_<type>_doall | ||
163 | to deallocate any remaining entries in the hash table (see below). | ||
164 | .Pp | ||
165 | .Fn lh_<type>_insert | ||
166 | inserts the structure pointed to by | ||
167 | .Fa data | ||
168 | into | ||
169 | .Fa table . | ||
170 | If there already is an entry with the same key, the old value is | ||
171 | replaced. | ||
172 | Note that | ||
173 | .Fn lh_<type>_insert | ||
174 | stores pointers, the data are not copied. | ||
175 | .Pp | ||
176 | .Fn lh_<type>_delete | ||
177 | deletes an entry from | ||
178 | .Fa table . | ||
179 | .Pp | ||
180 | .Fn lh_<type>_retrieve | ||
181 | looks up an entry in | ||
182 | .Fa table . | ||
183 | Normally, | ||
184 | .Fa data | ||
185 | is a structure with the key field(s) set; the function will return a | ||
186 | pointer to a fully populated structure. | ||
187 | .Pp | ||
188 | .Fn lh_<type>_doall | ||
189 | will, for every entry in the hash table, call | ||
190 | .Fa func | ||
191 | with the data item as its parameter. | ||
192 | For | ||
193 | .Fn lh_<type>_doall | ||
194 | and | ||
195 | .Fn lh_<type>_doall_arg , | ||
196 | function pointer casting should be avoided in the callbacks (see | ||
197 | .Sx NOTES ) | ||
198 | \(em instead use the declare/implement macros to create type-checked | ||
199 | wrappers that cast variables prior to calling your type-specific | ||
200 | callbacks. | ||
201 | An example of this is illustrated here where the callback is used to | ||
202 | cleanup resources for items in the hash table prior to the hashtable | ||
203 | itself being deallocated: | ||
204 | .Bd -literal -offset 2n | ||
205 | /* Clean up resources belonging to 'a' (this is implemented elsewhere) */ | ||
206 | void STUFF_cleanup_doall(STUFF *a); | ||
207 | /* Implement a prototype-compatible wrapper for "STUFF_cleanup" */ | ||
208 | IMPLEMENT_LHASH_DOALL_FN(STUFF_cleanup, STUFF) | ||
209 | /* ... then later in the code ... */ | ||
210 | /* So to run "STUFF_cleanup" against all items in a hash table ... */ | ||
211 | lh_STUFF_doall(hashtable, LHASH_DOALL_FN(STUFF_cleanup)); | ||
212 | /* Then the hash table itself can be deallocated */ | ||
213 | lh_STUFF_free(hashtable); | ||
214 | .Ed | ||
215 | .Pp | ||
216 | When doing this, be careful if you delete entries from the hash table in | ||
217 | your callbacks: the table may decrease in size, moving the item that you | ||
218 | are currently on down lower in the hash table \(em this could cause some | ||
219 | entries to be skipped during the iteration. | ||
220 | The second best solution to this problem is to set hash->down_load=0 | ||
221 | before you start (which will stop the hash table ever decreasing in | ||
222 | size). | ||
223 | The best solution is probably to avoid deleting items from the hash | ||
224 | table inside a doall callback! | ||
225 | .Pp | ||
226 | .Fn lh_<type>_doall_arg | ||
227 | is the same as | ||
228 | .Fn lh_<type>_doall | ||
229 | except that | ||
230 | .Fa func | ||
231 | will be called with | ||
232 | .Fa arg | ||
233 | as the second argument and | ||
234 | .Fa func | ||
235 | should be of type | ||
236 | .Vt LHASH_DOALL_ARG_FN_TYPE | ||
237 | (a callback prototype that is passed both the table entry and an extra | ||
238 | argument). | ||
239 | As with | ||
240 | .Fn lh_<type>_doall , | ||
241 | you can instead choose to declare your callback with a prototype | ||
242 | matching the types you are dealing with and use the declare/implement | ||
243 | macros to create compatible wrappers that cast variables before calling | ||
244 | your type-specific callbacks. | ||
245 | An example of this is demonstrated here (printing all hash table entries | ||
246 | to a BIO that is provided by the caller): | ||
247 | .Bd -literal -offset 2n | ||
248 | /* Print item 'a' to 'output_bio' (this is implemented elsewhere) */ | ||
249 | void STUFF_print_doall_arg(const STUFF *a, BIO *output_bio); | ||
250 | /* Implement a prototype-compatible wrapper for "STUFF_print" */ | ||
251 | static IMPLEMENT_LHASH_DOALL_ARG_FN(STUFF, const STUFF, BIO) | ||
252 | /* ... then later in the code ... */ | ||
253 | /* Print out the entire hashtable to a particular BIO */ | ||
254 | lh_STUFF_doall_arg(hashtable, LHASH_DOALL_ARG_FN(STUFF_print), BIO, | ||
255 | logging_bio); | ||
256 | .Ed | ||
257 | .Pp | ||
258 | .Fn lh_<type>_error | ||
259 | can be used to determine if an error occurred in the last operation. | ||
260 | .Fn lh_<type>_error | ||
261 | is a macro. | ||
262 | .Sh RETURN VALUES | ||
263 | .Fn lh_<type>_new | ||
264 | returns | ||
265 | .Dv NULL | ||
266 | on error, otherwise a pointer to the new | ||
267 | .Vt LHASH | ||
268 | structure. | ||
269 | .Pp | ||
270 | When a hash table entry is replaced, | ||
271 | .Fn lh_<type>_insert | ||
272 | returns the value being replaced. | ||
273 | .Dv NULL | ||
274 | is returned on normal operation and on error. | ||
275 | .Pp | ||
276 | .Fn lh_<type>_delete | ||
277 | returns the entry being deleted. | ||
278 | .Dv NULL | ||
279 | is returned if there is no such value in the hash table. | ||
280 | .Pp | ||
281 | .Fn lh_<type>_retrieve | ||
282 | returns the hash table entry if it has been found, or | ||
283 | .Dv NULL | ||
284 | otherwise. | ||
285 | .Pp | ||
286 | .Fn lh_<type>_error | ||
287 | returns 1 if an error occurred in the last operation, or 0 otherwise. | ||
288 | .Pp | ||
289 | .Fn lh_<type>_free , | ||
290 | .Fn lh_<type>_doall , | ||
291 | and | ||
292 | .Fn lh_<type>_doall_arg | ||
293 | return no values. | ||
294 | .Sh NOTES | ||
295 | The various LHASH macros and callback types exist to make it possible to | ||
296 | write type-checked code without resorting to function-prototype casting | ||
297 | \(em an evil that makes application code much harder to audit/verify and | ||
298 | also opens the window of opportunity for stack corruption and other | ||
299 | hard-to-find bugs. | ||
300 | It also, apparently, violates ANSI-C. | ||
301 | .Pp | ||
302 | The LHASH code regards table entries as constant data. | ||
303 | As such, it internally represents | ||
304 | .Fn lh_<type>_insert Ap ed | ||
305 | items with a | ||
306 | .Vt const void * | ||
307 | pointer type. | ||
308 | This is why callbacks such as those used by | ||
309 | .Fn lh_<type>_doall | ||
310 | and | ||
311 | .Fn lh_<type>_doall_arg | ||
312 | declare their prototypes with "const", even for the parameters that pass | ||
313 | back the table items' data pointers \(em for consistency, user-provided | ||
314 | data is "const" at all times as far as the LHASH code is concerned. | ||
315 | However, as callers are themselves providing these pointers, they can | ||
316 | choose whether they too should be treating all such parameters as | ||
317 | constant. | ||
318 | .Pp | ||
319 | As an example, a hash table may be maintained by code that, for | ||
320 | reasons of encapsulation, has only "const" access to the data being | ||
321 | indexed in the hash table (i.e. it is returned as "const" from | ||
322 | elsewhere in their code) \(em in this case the LHASH prototypes are | ||
323 | appropriate as-is. | ||
324 | Conversely, if the caller is responsible for the life-time of the data | ||
325 | in question, then they may well wish to make modifications to table item | ||
326 | passed back in the | ||
327 | .Fn lh_<type>_doall | ||
328 | or | ||
329 | .Fn lh_<type>_doall_arg | ||
330 | callbacks (see the "STUFF_cleanup" example above). | ||
331 | If so, the caller can either cast the "const" away (if they're providing | ||
332 | the raw callbacks themselves) or use the macros to declare/implement the | ||
333 | wrapper functions without "const" types. | ||
334 | .Pp | ||
335 | Callers that only have "const" access to data they are indexing in a | ||
336 | table, yet declare callbacks without constant types (or cast the "const" | ||
337 | away themselves), are therefore creating their own risks/bugs without | ||
338 | being encouraged to do so by the API. | ||
339 | On a related note, those auditing code should pay special attention | ||
340 | to any instances of DECLARE/IMPLEMENT_LHASH_DOALL_[ARG_]_FN macros | ||
341 | that provide types without any "const" qualifiers. | ||
342 | .Sh INTERNALS | ||
343 | The following description is based on the SSLeay documentation: | ||
344 | .Pp | ||
345 | The lhash library implements a hash table described in the | ||
346 | .Em Communications of the ACM | ||
347 | in 1991. | ||
348 | What makes this hash table different is that as the table fills, | ||
349 | the hash table is increased (or decreased) in size via | ||
350 | .Xr OPENSSL_realloc 3 . | ||
351 | When a 'resize' is done, instead of all hashes being redistributed over | ||
352 | twice as many 'buckets', one bucket is split. | ||
353 | So when an 'expand' is done, there is only a minimal cost to | ||
354 | redistribute some values. | ||
355 | Subsequent inserts will cause more single 'bucket' redistributions but | ||
356 | there will never be a sudden large cost due to redistributing all the | ||
357 | \&'buckets'. | ||
358 | .Pp | ||
359 | The state for a particular hash table is kept in the | ||
360 | .Vt LHASH | ||
361 | structure. | ||
362 | The decision to increase or decrease the hash table size is made | ||
363 | depending on the 'load' of the hash table. | ||
364 | The load is the number of items in the hash table divided by the size of | ||
365 | the hash table. | ||
366 | The default values are as follows. | ||
367 | If (hash->up_load < load) => expand. | ||
368 | if (hash->down_load > load) => contract. | ||
369 | The | ||
370 | .Fa up_load | ||
371 | has a default value of 1 and | ||
372 | .Fa down_load | ||
373 | has a default value of 2. | ||
374 | These numbers can be modified by the application by just playing | ||
375 | with the | ||
376 | .Fa up_load | ||
377 | and | ||
378 | .Fa down_load | ||
379 | variables. | ||
380 | The 'load' is kept in a form which is multiplied by 256. | ||
381 | So hash->up_load=8*256 will cause a load of 8 to be set. | ||
382 | .Pp | ||
383 | If you are interested in performance the field to watch is | ||
384 | .Fa num_comp_calls . | ||
385 | The hash library keeps track of the 'hash' value for each item so when a | ||
386 | lookup is done, the 'hashes' are compared, if there is a match, then a | ||
387 | full compare is done, and hash->num_comp_calls is incremented. | ||
388 | If num_comp_calls is not equal to num_delete plus num_retrieve it means | ||
389 | that your hash function is generating hashes that are the same for | ||
390 | different values. | ||
391 | It is probably worth changing your hash function if this is the case | ||
392 | because even if your hash table has 10 items in a 'bucket', it can be | ||
393 | searched with 10 | ||
394 | .Vt unsigned long | ||
395 | compares and 10 linked list traverses. | ||
396 | This will be much less expensive that 10 calls to your compare function. | ||
397 | .Pp | ||
398 | .Fn lh_strhash | ||
399 | is a demo string hashing function: | ||
400 | .Pp | ||
401 | .Dl unsigned long lh_strhash(const char *c); | ||
402 | .Pp | ||
403 | Since the LHASH routines would normally be passed structures, this | ||
404 | routine would not normally be passed to | ||
405 | .Fn lh_<type>_new , | ||
406 | rather it would be used in the function passed to | ||
407 | .Fn lh_<type>_new . | ||
408 | .Sh SEE ALSO | ||
409 | .Xr lh_stats 3 | ||
410 | .Sh HISTORY | ||
411 | The lhash library is available in all versions of SSLeay and OpenSSL. | ||
412 | .Fn lh_<type>_error | ||
413 | was added in SSLeay 0.9.1b. | ||
414 | .Pp | ||
415 | In OpenSSL 0.9.7, all lhash functions that were passed function pointers | ||
416 | were changed for better type safety, and the function types | ||
417 | .Vt LHASH_COMP_FN_TYPE , | ||
418 | .Vt LHASH_HASH_FN_TYPE , | ||
419 | .Vt LHASH_DOALL_FN_TYPE , | ||
420 | and | ||
421 | .Vt LHASH_DOALL_ARG_FN_TYPE | ||
422 | became available. | ||
423 | .Pp | ||
424 | In OpenSSL 1.0.0, the lhash interface was revamped for even better type | ||
425 | checking. | ||
426 | .Sh BUGS | ||
427 | .Fn lh_<type>_insert | ||
428 | returns | ||
429 | .Dv NULL | ||
430 | both for success and error. | ||
diff --git a/src/lib/libcrypto/man/ui_new.3 b/src/lib/libcrypto/man/ui_new.3 new file mode 100644 index 0000000000..d841c212d8 --- /dev/null +++ b/src/lib/libcrypto/man/ui_new.3 | |||
@@ -0,0 +1,384 @@ | |||
1 | .Dd $Mdocdate: November 12 2015 $ | ||
2 | .Dt UI_NEW 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm UI_new , | ||
6 | .Nm UI_new_method , | ||
7 | .Nm UI_free , | ||
8 | .Nm UI_add_input_string , | ||
9 | .Nm UI_dup_input_string , | ||
10 | .Nm UI_add_verify_string , | ||
11 | .Nm UI_dup_verify_string , | ||
12 | .Nm UI_add_input_boolean , | ||
13 | .Nm UI_dup_input_boolean , | ||
14 | .Nm UI_add_info_string , | ||
15 | .Nm UI_dup_info_string , | ||
16 | .Nm UI_add_error_string , | ||
17 | .Nm UI_dup_error_string , | ||
18 | .Nm UI_construct_prompt , | ||
19 | .Nm UI_add_user_data , | ||
20 | .Nm UI_get0_user_data , | ||
21 | .Nm UI_get0_result , | ||
22 | .Nm UI_process , | ||
23 | .Nm UI_ctrl , | ||
24 | .Nm UI_set_default_method , | ||
25 | .Nm UI_get_default_method , | ||
26 | .Nm UI_get_method , | ||
27 | .Nm UI_set_method , | ||
28 | .Nm UI_OpenSSL , | ||
29 | .Nm ERR_load_UI_strings | ||
30 | .Nd New User Interface | ||
31 | .Sh SYNOPSIS | ||
32 | .In openssl/ui.h | ||
33 | .Fd typedef struct ui_st UI; | ||
34 | .Fd typedef struct ui_method_st UI_METHOD; | ||
35 | .Ft UI * | ||
36 | .Fn UI_new void | ||
37 | .Ft UI * | ||
38 | .Fo UI_new_method | ||
39 | .Fa "const UI_METHOD *method" | ||
40 | .Fc | ||
41 | .Ft void | ||
42 | .Fo UI_free | ||
43 | .Fa "UI *ui" | ||
44 | .Fc | ||
45 | .Ft int | ||
46 | .Fo UI_add_input_string | ||
47 | .Fa "UI *ui" | ||
48 | .Fa "const char *prompt" | ||
49 | .Fa "int flags" | ||
50 | .Fa "char *result_buf" | ||
51 | .Fa "int minsize" | ||
52 | .Fa "int maxsize" | ||
53 | .Fc | ||
54 | .Ft int | ||
55 | .Fo UI_dup_input_string | ||
56 | .Fa "UI *ui" | ||
57 | .Fa "const char *prompt" | ||
58 | .Fa "int flags" | ||
59 | .Fa "char *result_buf" | ||
60 | .Fa "int minsize" | ||
61 | .Fa "int maxsize" | ||
62 | .Fc | ||
63 | .Ft int | ||
64 | .Fo UI_add_verify_string | ||
65 | .Fa "UI *ui" | ||
66 | .Fa "const char *prompt" | ||
67 | .Fa "int flags" | ||
68 | .Fa "char *result_buf" | ||
69 | .Fa "int minsize" | ||
70 | .Fa "int maxsize" | ||
71 | .Fa "const char *test_buf" | ||
72 | .Fc | ||
73 | .Ft int | ||
74 | .Fo UI_dup_verify_string | ||
75 | .Fa "UI *ui" | ||
76 | .Fa "const char *prompt" | ||
77 | .Fa "int flags" | ||
78 | .Fa "char *result_buf" | ||
79 | .Fa "int minsize" | ||
80 | .Fa "int maxsize" | ||
81 | .Fa "const char *test_buf" | ||
82 | .Fc | ||
83 | .Ft int | ||
84 | .Fo UI_add_input_boolean | ||
85 | .Fa "UI *ui" | ||
86 | .Fa "const char *prompt" | ||
87 | .Fa "const char *action_desc" | ||
88 | .Fa "const char *ok_chars" | ||
89 | .Fa "const char *cancel_chars" | ||
90 | .Fa "int flags" | ||
91 | .Fa "char *result_buf" | ||
92 | .Fc | ||
93 | .Ft int | ||
94 | .Fo UI_dup_input_boolean | ||
95 | .Fa "UI *ui" | ||
96 | .Fa "const char *prompt" | ||
97 | .Fa "const char *action_desc" | ||
98 | .Fa "const char *ok_chars" | ||
99 | .Fa "const char *cancel_chars" | ||
100 | .Fa "int flags" | ||
101 | .Fa "char *result_buf" | ||
102 | .Fc | ||
103 | .Ft int | ||
104 | .Fo UI_add_info_string | ||
105 | .Fa "UI *ui" | ||
106 | .Fa "const char *text" | ||
107 | .Fc | ||
108 | .Ft int | ||
109 | .Fo UI_dup_info_string | ||
110 | .Fa "UI *ui" | ||
111 | .Fa "const char *text" | ||
112 | .Fc | ||
113 | .Ft int | ||
114 | .Fo UI_add_error_string | ||
115 | .Fa "UI *ui" | ||
116 | .Fa "const char *text" | ||
117 | .Fc | ||
118 | .Ft int | ||
119 | .Fo UI_dup_error_string | ||
120 | .Fa "UI *ui" | ||
121 | .Fa "const char *text" | ||
122 | .Fc | ||
123 | .Fd /* These are the possible flags. They can be OR'ed together. */ | ||
124 | .Fd #define UI_INPUT_FLAG_ECHO 0x01 | ||
125 | .Fd #define UI_INPUT_FLAG_DEFAULT_PWD 0x02 | ||
126 | .Ft char * | ||
127 | .Fo UI_construct_prompt | ||
128 | .Fa "UI *ui_method" | ||
129 | .Fa "const char *object_desc" | ||
130 | .Fa "const char *object_name" | ||
131 | .Fc | ||
132 | .Ft void * | ||
133 | .Fo UI_add_user_data | ||
134 | .Fa "UI *ui" | ||
135 | .Fa "void *user_data" | ||
136 | .Fc | ||
137 | .Ft void * | ||
138 | .Fo UI_get0_user_data | ||
139 | .Fa "UI *ui" | ||
140 | .Fc | ||
141 | .Ft const char * | ||
142 | .Fo UI_get0_result | ||
143 | .Fa "UI *ui" | ||
144 | .Fa "int i" | ||
145 | .Fc | ||
146 | .Ft int | ||
147 | .Fo UI_process | ||
148 | .Fa "UI *ui" | ||
149 | .Fc | ||
150 | .Ft int | ||
151 | .Fo UI_ctrl | ||
152 | .Fa "UI *ui" | ||
153 | .Fa "int cmd" | ||
154 | .Fa "long i" | ||
155 | .Fa "void *p" | ||
156 | .Fa "void (*f)()" | ||
157 | .Fc | ||
158 | .Fd #define UI_CTRL_PRINT_ERRORS 1 | ||
159 | .Fd #define UI_CTRL_IS_REDOABLE 2 | ||
160 | .Ft void | ||
161 | .Fo UI_set_default_method | ||
162 | .Fa "const UI_METHOD *meth" | ||
163 | .Fc | ||
164 | .Ft const UI_METHOD * | ||
165 | .Fo UI_get_default_method | ||
166 | .Fa void | ||
167 | .Fc | ||
168 | .Ft const UI_METHOD * | ||
169 | .Fo UI_get_method | ||
170 | .Fa "UI *ui" | ||
171 | .Fc | ||
172 | .Ft const UI_METHOD * | ||
173 | .Fo UI_set_method | ||
174 | .Fa "UI *ui" | ||
175 | .Fa "const UI_METHOD *meth" | ||
176 | .Fc | ||
177 | .Ft UI_METHOD * | ||
178 | .Fo UI_OpenSSL | ||
179 | .Fa void | ||
180 | .Fc | ||
181 | .Sh DESCRIPTION | ||
182 | UI stands for User Interface, and is general purpose set of routines | ||
183 | to prompt the user for text-based information. | ||
184 | Through user-written methods (see | ||
185 | .Xr ui_create 3 Ns ), | ||
186 | prompting can be done in any way imaginable, be it plain text prompting, | ||
187 | through dialog boxes or from a cell phone. | ||
188 | .Pp | ||
189 | All the functions work through a context of the type | ||
190 | .Vt UI . | ||
191 | This context contains all the information needed to prompt correctly | ||
192 | as well as a reference to a | ||
193 | .Vt UI_METHOD , | ||
194 | which is an ordered vector of functions that carry out the actual | ||
195 | prompting. | ||
196 | .Pp | ||
197 | The first thing to do is to create a | ||
198 | .Vt UI | ||
199 | with | ||
200 | .Fn UI_new | ||
201 | or | ||
202 | .Fn UI_new_method , | ||
203 | then add information to it with the | ||
204 | .Fn UI_add_* | ||
205 | or | ||
206 | .Fn UI_dup_* | ||
207 | functions. | ||
208 | Also, user-defined random data can be passed down to the underlying | ||
209 | method through calls to | ||
210 | .Fn UI_add_user_data . | ||
211 | The default UI method doesn't care about these data, but other methods | ||
212 | might. | ||
213 | Finally, use | ||
214 | .Fn UI_process | ||
215 | to actually perform the prompting and | ||
216 | .Fn UI_get0_result | ||
217 | to find the result to the prompt. | ||
218 | .Pp | ||
219 | A | ||
220 | .Vt UI | ||
221 | can contain more than one prompt, which are performed in the given | ||
222 | sequence. | ||
223 | Each prompt gets an index number which is returned by the | ||
224 | .Fn UI_add_* | ||
225 | and | ||
226 | .Fn UI_dup_* | ||
227 | functions, and has to be used to get the corresponding result with | ||
228 | .Fn UI_get0_result . | ||
229 | .Pp | ||
230 | The functions are as follows: | ||
231 | .Pp | ||
232 | .Fn UI_new | ||
233 | creates a new | ||
234 | .Vt UI | ||
235 | using the default UI method. | ||
236 | When done with this UI, it should be freed using | ||
237 | .Fn UI_free . | ||
238 | .Pp | ||
239 | .Fn UI_new_method | ||
240 | creates a new | ||
241 | .Vt UI | ||
242 | using the given UI method. | ||
243 | When done with this UI, it should be freed using | ||
244 | .Fn UI_free . | ||
245 | .Pp | ||
246 | .Fn UI_OpenSSL | ||
247 | returns the built-in UI method (note: not the default one, since | ||
248 | the default can be changed. | ||
249 | See further on). | ||
250 | This method is the most machine/OS dependent part of OpenSSL and | ||
251 | normally generates the most problems when porting. | ||
252 | .Pp | ||
253 | .Fn UI_free | ||
254 | removes | ||
255 | .Fa ui | ||
256 | from memory, along with all other pieces of memory that are connected | ||
257 | to it, like duplicated input strings, results and others. | ||
258 | .Pp | ||
259 | .Fn UI_add_input_string | ||
260 | and | ||
261 | .Fn UI_add_verify_string | ||
262 | add a prompt to | ||
263 | .Fa ui , | ||
264 | as well as flags and a result buffer and the desired minimum and | ||
265 | maximum sizes of the result. | ||
266 | The given information is used to prompt for information, for example | ||
267 | a password, and to verify a password (i.e. having the user enter | ||
268 | it twice and check that the same string was entered twice). | ||
269 | .Fn UI_add_verify_string | ||
270 | takes and extra argument that should be a pointer to the result buffer | ||
271 | of the input string that it's supposed to verify, or verification will | ||
272 | fail. | ||
273 | .Pp | ||
274 | .Fn UI_add_input_boolean | ||
275 | adds a prompt to | ||
276 | .Fa ui | ||
277 | that's supposed to be answered in a boolean way, with a single | ||
278 | character for yes and a different character for no. | ||
279 | A set of characters that can be used to cancel the prompt is given as | ||
280 | well. | ||
281 | The prompt itself is really divided in two, one part being the | ||
282 | descriptive text (given through the | ||
283 | .Fa prompt | ||
284 | argument) and one describing the possible answers (given through the | ||
285 | .Fa action_desc | ||
286 | argument). | ||
287 | .Pp | ||
288 | .Fn UI_add_info_string | ||
289 | and | ||
290 | .Fn UI_add_error_string | ||
291 | add strings that are shown at the same time as the prompt for extra | ||
292 | information or to show an error string. | ||
293 | The difference between the two is only conceptual. | ||
294 | With the builtin method, there's no technical difference between them. | ||
295 | Other methods may make a difference between them, however. | ||
296 | .Pp | ||
297 | The flags currently supported are | ||
298 | .Dv UI_INPUT_FLAG_ECHO, | ||
299 | which is relevant for | ||
300 | .Fn UI_add_input_string | ||
301 | and will have the users response be echoed (when prompting for a | ||
302 | password, this flag should obviously not be used), and | ||
303 | .Dv UI_INPUT_FLAG_DEFAULT_PWD , | ||
304 | which means that a default password of some sort will be used | ||
305 | (completely depending on the application and the UI method). | ||
306 | .Pp | ||
307 | .Fn UI_dup_input_string , | ||
308 | .Fn UI_dup_verify_string , | ||
309 | .Fn UI_dup_input_boolean , | ||
310 | .Fn UI_dup_info_string , | ||
311 | and | ||
312 | .Fn UI_dup_error_string | ||
313 | are basically the same as their | ||
314 | .Fn UI_add_* | ||
315 | counterparts, except that they make their own copies of all strings. | ||
316 | .Pp | ||
317 | .Fn UI_construct_prompt | ||
318 | is a helper function that can be used to create a prompt from two pieces | ||
319 | of information: an description and a name. | ||
320 | The default constructor (if there is none provided by the method used) | ||
321 | creates a string "Enter | ||
322 | .Em description | ||
323 | for | ||
324 | .Em name Ns :". | ||
325 | With the description "pass phrase" and the file name "foo.key", that | ||
326 | becomes "Enter pass phrase for foo.key:". Other methods may create | ||
327 | whatever string and may include encodings that will be processed by the | ||
328 | other method functions. | ||
329 | .Pp | ||
330 | .Fn UI_add_user_data | ||
331 | adds a piece of memory for the method to use at any time. | ||
332 | The builtin UI method doesn't care about this info. | ||
333 | Note that several calls to this function doesn't add data, it replaces | ||
334 | the previous blob with the one given as argument. | ||
335 | .Pp | ||
336 | .Fn UI_get0_user_data | ||
337 | retrieves the data that has last been given to the | ||
338 | .Fa ui | ||
339 | with | ||
340 | .Fn UI_add_user_data . | ||
341 | .Pp | ||
342 | .Fn UI_get0_result | ||
343 | returns a pointer to the result buffer associated with the information | ||
344 | indexed by | ||
345 | .Fa i . | ||
346 | .Pp | ||
347 | .Fn UI_process | ||
348 | goes through the information given so far, does all the printing and | ||
349 | prompting and returns. | ||
350 | .Pp | ||
351 | .Fn UI_ctrl | ||
352 | adds extra control for the application author. | ||
353 | For now, it understands two commands: | ||
354 | .Dv UI_CTRL_PRINT_ERRORS , | ||
355 | which makes | ||
356 | .Fn UI_process | ||
357 | print the OpenSSL error stack as part of processing the | ||
358 | .Fa ui , | ||
359 | and | ||
360 | .Dv UI_CTRL_IS_REDOABLE , | ||
361 | which returns a flag saying if the used | ||
362 | .Fa ui | ||
363 | can be used again or not. | ||
364 | .Pp | ||
365 | .Fn UI_set_default_method | ||
366 | changes the default UI method to the one given. | ||
367 | .Pp | ||
368 | .Fn UI_get_default_method | ||
369 | returns a pointer to the current default UI method. | ||
370 | .Pp | ||
371 | .Fn UI_get_method | ||
372 | returns the UI method associated with a given | ||
373 | .Fa ui . | ||
374 | .Pp | ||
375 | .Fn UI_set_method | ||
376 | changes the UI method associated with a given | ||
377 | .Fa ui . | ||
378 | .Sh SEE ALSO | ||
379 | .Xr des_read_pw 3 | ||
380 | .Sh HISTORY | ||
381 | The UI section was first introduced in OpenSSL 0.9.7. | ||
382 | .Sh AUTHORS | ||
383 | .An Richard Levitte Aq Mt richard@levitte.org | ||
384 | for the OpenSSL project. | ||