summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2015-11-11 21:15:15 +0000
committerschwarze <>2015-11-11 21:15:15 +0000
commit22f89c8c27130dce389c2cba215b4cdd0deadd22 (patch)
treedf165a08270ef8df757ccda21dbd1c609633bd3f /src/lib
parent0241f6701aac0e95428b9f0899b07ba086aa7e71 (diff)
downloadopenbsd-22f89c8c27130dce389c2cba215b4cdd0deadd22.tar.gz
openbsd-22f89c8c27130dce389c2cba215b4cdd0deadd22.tar.bz2
openbsd-22f89c8c27130dce389c2cba215b4cdd0deadd22.zip
Convert five more manuals from POD to mdoc.
I found drafts of these in my tree, probably originally from Max Fillinger, that just needed minor polishing.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/CONF_modules_free.356
-rw-r--r--src/lib/libcrypto/man/CONF_modules_load_file.382
-rw-r--r--src/lib/libcrypto/man/CRYPTO_set_ex_data.370
-rw-r--r--src/lib/libcrypto/man/CRYPTO_set_locking_callback.3321
-rw-r--r--src/lib/libcrypto/man/Makefile10
-rw-r--r--src/lib/libcrypto/man/crypto.3104
-rw-r--r--src/lib/libssl/src/doc/crypto/CONF_modules_free.pod47
-rw-r--r--src/lib/libssl/src/doc/crypto/CONF_modules_load_file.pod60
-rw-r--r--src/lib/libssl/src/doc/crypto/CRYPTO_set_ex_data.pod56
-rw-r--r--src/lib/libssl/src/doc/crypto/CRYPTO_set_locking_callback.pod210
-rw-r--r--src/lib/libssl/src/doc/crypto/crypto.pod85
11 files changed, 638 insertions, 463 deletions
diff --git a/src/lib/libcrypto/man/CONF_modules_free.3 b/src/lib/libcrypto/man/CONF_modules_free.3
new file mode 100644
index 0000000000..b09989d664
--- /dev/null
+++ b/src/lib/libcrypto/man/CONF_modules_free.3
@@ -0,0 +1,56 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CONF_MODULES_FREE 3
3.Os
4.Sh NAME
5.Nm CONF_modules_free ,
6.Nm CONF_modules_finish ,
7.Nm CONF_modules_unload
8.Nd OpenSSL configuration cleanup functions
9.Sh SYNOPSIS
10.In openssl/conf.h
11.Ft void
12.Fo CONF_modules_free
13.Fa void
14.Fc
15.Ft void
16.Fo CONF_modules_finish
17.Fa void
18.Fc
19.Ft void
20.Fo CONF_modules_unload
21.Fa "int all"
22.Fc
23.Sh DESCRIPTION
24.Fn CONF_modules_free
25closes down and frees up all memory allocated by all configuration
26modules.
27.Pp
28.Fn CONF_modules_finish
29calls the configuration
30.Sy finish
31handler of each configuration module to free up any configuration
32that module may have performed.
33.Pp
34.Fn CONF_modules_unload
35finishes and unloads configuration modules.
36If
37.Fa all
38is set to 0, only modules loaded from DSOs will be unloaded.
39If
40.Fa all
41is 1, all modules, including builtin modules, will be unloaded.
42.Sh NOTES
43Normally applications will only call
44.Fn CONF_modules_free
45at application to tidy up any configuration performed.
46.Sh RETURN VALUE
47None of the functions return a value.
48.Sh SEE ALSO
49.Xr CONF_modules_load_file 3 ,
50.Xr OPENSSL_config 3
51.Sh HISTORY
52.Fn CONF_modules_free ,
53.Fn CONF_modules_unload ,
54and
55.Fn CONF_modules_finish
56first appeared in OpenSSL 0.9.7.
diff --git a/src/lib/libcrypto/man/CONF_modules_load_file.3 b/src/lib/libcrypto/man/CONF_modules_load_file.3
new file mode 100644
index 0000000000..b5de94411d
--- /dev/null
+++ b/src/lib/libcrypto/man/CONF_modules_load_file.3
@@ -0,0 +1,82 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CONF_MODULES_LOAD_FILE 3
3.Os
4.Sh NAME
5.Nm CONF_modules_load_file ,
6.Nm CONF_modules_load
7.Nd OpenSSL configuration functions
8.Sh SYNOPSIS
9.In openssl/conf.h
10.Ft int
11.Fo CONF_modules_load_file
12.Fa "const char *filename"
13.Fa "const char *appname"
14.Fa "unsigned long flags"
15.Fc
16.Ft int
17.Fo CONF_modules_load
18.Fa "const CONF *cnf"
19.Fa "const char *appname"
20.Fa "unsigned long flags"
21.Fc
22.Sh DESCRIPTION
23The function
24.Fn CONF_modules_load_file
25configures OpenSSL using file
26.Fa filename
27and application name
28.Fa appname .
29If
30.Fa filename
31is
32.Dv NULL ,
33the standard OpenSSL configuration file is used.
34If
35.Fa appname
36is
37.Dv NULL ,
38the standard OpenSSL application name
39.Qq openssl_conf
40is used.
41The behaviour can be cutomized using
42.Fa flags .
43.Pp
44.Fn CONF_modules_load
45is idential to
46.Fn CONF_modules_load_file
47except it reads configuration information from
48.Fa cnf .
49.Pp
50The following
51.Fa flags
52are currently recognized:
53.Bl -tag -width Ds
54.It Dv CONF_MFLAGS_IGNORE_ERRORS
55Ignore errors returned by individual configuration modules.
56By default, the first module error is considered fatal and no further
57modules are loaded.
58.It Dv CONF_MFLAGS_SILENT
59Do not add any error information.
60By default, all module errors add error information to the error queue.
61.It Dv CONF_MFLAGS_NO_DSO
62Disable loading of configuration modules from DSOs.
63.It Dv CONF_MFLAGS_IGNORE_MISSING_FILE
64Let
65.Fn CONF_modules_load_file
66ignore missing configuration files.
67By default, a missing configuration file returns an error.
68.El
69.Sh RETURN VALUES
70These functions return 1 for success and zero or a negative value for
71failure.
72If module errors are not ignored, the return code will reflect the return
73value of the failing module (this will always be zero or negative).
74.Sh SEE ALSO
75.Xr CONF_free 3 ,
76.Xr ERR 3 ,
77.Xr OPENSSL_config 3
78.Sh HISTORY
79.Fn CONF_modules_load_file
80and
81.Fn CONF_modules_load
82first appeared in OpenSSL 0.9.7.
diff --git a/src/lib/libcrypto/man/CRYPTO_set_ex_data.3 b/src/lib/libcrypto/man/CRYPTO_set_ex_data.3
new file mode 100644
index 0000000000..1be42dedd9
--- /dev/null
+++ b/src/lib/libcrypto/man/CRYPTO_set_ex_data.3
@@ -0,0 +1,70 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CRYPTO_SET_EX_DATA 3
3.Os
4.Sh NAME
5.Nm CRYPTO_set_ex_data ,
6.Nm CRYPTO_get_ex_data
7.Nd internal application specific data functions
8.Sh SYNOPSIS
9.In openssl/crypto.h
10.Ft int
11.Fo CRYPTO_set_ex_data
12.Fa "CRYPTO_EX_DATA *r"
13.Fa "int idx"
14.Fa "void *arg"
15.Fc
16.Ft void *
17.Fo CRYPTO_get_ex_data
18.Fa "CRYPTO_EX_DATA *r"
19.Fa "int idx"
20.Fc
21.Sh DESCRIPTION
22Several OpenSSL structures can have application specific data attached
23to them.
24These functions are used internally by OpenSSL to manipulate application
25specific data attached to a specific structure.
26.Pp
27These functions should only be used by applications to manipulate
28.Vt CRYPTO_EX_DATA
29structures passed to the
30.Fn new_func ,
31.Fn free_func ,
32and
33.Fn dup_func
34callbacks: as passed to
35.Xr RSA_get_ex_new_index 3
36for example.
37.Pp
38.Fn CRYPTO_set_ex_data
39is used to set application specific data, the data is supplied in the
40.Fa arg
41parameter and its precise meaning is up to the application.
42.Pp
43.Fn CRYPTO_get_ex_data
44is used to retrieve application specific data.
45The data is returned to the application, this will be the same value as
46supplied to a previous
47.Fn CRYPTO_set_ex_data
48call.
49.Sh RETURN VALUES
50.Fn CRYPTO_set_ex_data
51returns 1 on success or 0 on failure.
52.Pp
53.Fn CRYPTO_get_ex_data
54returns the application data or 0 on failure.
550 may also be valid application data but currently it can only fail if
56given an invalid
57.Fa idx
58parameter.
59.Pp
60On failure an error code can be obtained from
61.Xr ERR_get_error 3 .
62.Sh SEE ALSO
63.Xr DH_get_ex_new_index 3 ,
64.Xr DSA_get_ex_new_index 3 ,
65.Xr RSA_get_ex_new_index 3
66.Sh HISTORY
67.Fn CRYPTO_set_ex_data
68and
69.Fn CRYPTO_get_ex_data
70have been available since SSLeay 0.9.0.
diff --git a/src/lib/libcrypto/man/CRYPTO_set_locking_callback.3 b/src/lib/libcrypto/man/CRYPTO_set_locking_callback.3
new file mode 100644
index 0000000000..d6290852b5
--- /dev/null
+++ b/src/lib/libcrypto/man/CRYPTO_set_locking_callback.3
@@ -0,0 +1,321 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CRYPTO_SET_LOCKING_CALLBACK 3
3.Os
4.Sh NAME
5.Nm CRYPTO_THREADID_set_callback ,
6.Nm CRYPTO_THREADID_get_callback ,
7.Nm CRYPTO_THREADID_current ,
8.Nm CRYPTO_THREADID_cmp ,
9.Nm CRYPTO_THREADID_cpy ,
10.Nm CRYPTO_THREADID_hash ,
11.Nm CRYPTO_set_locking_callback ,
12.Nm CRYPTO_num_locks ,
13.Nm CRYPTO_set_dynlock_create_callback ,
14.Nm CRYPTO_set_dynlock_lock_callback ,
15.Nm CRYPTO_set_dynlock_destroy_callback ,
16.Nm CRYPTO_get_new_dynlockid ,
17.Nm CRYPTO_destroy_dynlockid ,
18.Nm CRYPTO_lock
19.Nd OpenSSL thread support
20.Sh SYNOPSIS
21.In openssl/crypto.h
22.Bd -literal
23/* Don't use this structure directly. */
24typedef struct crypto_threadid_st {
25 void *ptr;
26 unsigned long val;
27} CRYPTO_THREADID;
28/* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
29.Ed
30.Pp
31.Ft void
32.Fo CRYPTO_THREADID_set_numeric
33.Fa "CRYPTO_THREADID *id"
34.Fa "unsigned long val"
35.Fc
36.Ft void
37.Fo CRYPTO_THREADID_set_pointer
38.Fa "CRYPTO_THREADID *id"
39.Fa "void *ptr"
40.Fc
41.Ft int
42.Fo CRYPTO_THREADID_set_callback
43.Fa "void (*threadid_func)(CRYPTO_THREADID *)"
44.Fc
45.Ft void
46.Fo "(*CRYPTO_THREADID_get_callback(void))"
47.Fa "CRYPTO_THREADID *"
48.Fc
49.Ft void
50.Fo CRYPTO_THREADID_current
51.Fa "CRYPTO_THREADID *id"
52.Fc
53.Ft int
54.Fo CRYPTO_THREADID_cmp
55.Fa "const CRYPTO_THREADID *a"
56.Fa "const CRYPTO_THREADID *b"
57.Fc
58.Ft void
59.Fo CRYPTO_THREADID_cpy
60.Fa "CRYPTO_THREADID *dest"
61.Fa "const CRYPTO_THREADID *src"
62.Fc
63.Ft unsigned long
64.Fo CRYPTO_THREADID_hash
65.Fa "const CRYPTO_THREADID *id"
66.Fc
67.Ft int
68.Fo CRYPTO_num_locks
69.Fa void
70.Fc
71.Bd -literal
72/* struct CRYPTO_dynlock_value needs to be defined by the user */
73struct CRYPTO_dynlock_value;
74.Ed
75.Pp
76.Ft void
77.Fo CRYPTO_set_dynlock_create_callback
78.Fa "struct CRYPTO_dynlock_value *"
79.Fa "(*dyn_create_function)(char *file, int line)"
80.Fc
81.Ft void
82.Fo CRYPTO_set_dynlock_lock_callback
83.Fa "void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l,\
84 const char *file, int line)"
85.Fc
86.Ft void
87.Fo CRYPTO_set_dynlock_destroy_callback
88.Fa "void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l,\
89 const char *file, int line)"
90.Fc
91.Ft int
92.Fo CRYPTO_get_new_dynlockid
93.Fa void
94.Fc
95.Ft void
96.Fo CRYPTO_destroy_dynlockid
97.Fa "int i"
98.Fc
99.Ft void
100.Fo CRYPTO_lock
101.Fa "int mode"
102.Fa "int n"
103.Fa "const char *file"
104.Fa "int line"
105.Fc
106.Bd -literal
107#define CRYPTO_w_lock(type) \e
108 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE, type, __FILE__, __LINE__)
109#define CRYPTO_w_unlock(type) \e
110 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE, type, __FILE__, __LINE__)
111#define CRYPTO_r_lock(type) \e
112 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ, type, __FILE__, __LINE__)
113#define CRYPTO_r_unlock(type) \e
114 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ, type, __FILE__, __LINE__)
115#define CRYPTO_add(addr,amount,type) \e
116 CRYPTO_add_lock(addr, amount, type, __FILE__, __LINE__)
117.Ed
118.Sh DESCRIPTION
119OpenSSL can safely be used in multi-threaded applications provided that
120at least two callback functions are set,
121.Fn locking_function
122and
123.Fn threadid_func .
124.Pp
125.Fo locking_function
126.Fa "int mode"
127.Fa "int n"
128.Fa "const char *file"
129.Fa "int line"
130.Fc
131is needed to perform locking on shared data structures.
132Note that OpenSSL uses a number of global data structures that will be
133implicitly shared whenever multiple threads use OpenSSL.
134Multi-threaded applications will crash at random if it is not set.
135.Pp
136.Fn locking_function
137must be able to handle up to
138.Fn CRYPTO_num_locks
139different mutex locks.
140It sets the
141.Fa n Ns -th
142lock if
143.Fa mode
144includes
145.Dv CRYPTO_LOCK ,
146and releases it otherwise.
147.Pp
148.Fa file
149and
150.Fa line
151are the file number of the function setting the lock.
152They can be useful for debugging.
153.Pp
154.Fo threadid_func
155.Fa "CRYPTO_THREADID *id"
156.Fc
157is needed to record the currently-executing thread's identifier into
158.Fa id .
159The implementation of this callback should not fill in
160.Fa id
161directly, but should use
162.Fn CRYPTO_THREADID_set_numeric
163if thread IDs are numeric, or
164.Fn CRYPTO_THREADID_set_pointer
165if they are pointer-based.
166If the application does not register such a callback using
167.Fn CRYPTO_THREADID_set_callback ,
168then a default implementation is used - on Windows and BeOS this uses
169the system's default thread identifying APIs, and on all other platforms
170it uses the address of
171.Va errno .
172The latter is satisfactory for thread-safety if and only if the platform
173has a thread-local error number facility.
174.Pp
175Once
176.Fn threadid_func
177is registered, or if the built-in default implementation is to be used,
178.Bl -bullet
179.It
180.Fn CRYPTO_THREADID_current
181records the currently-executing thread ID into the given
182.Fa id
183object.
184.It
185.Fn CRYPTO_THREADID_cmp
186compares two thread IDs (returning zero for equality, i.e. the same
187semantics as
188.Xr memcmp 3 ) .
189.It
190.Fn CRYPTO_THREADID_cpy
191duplicates a thread ID value.
192.It
193.Fn CRYPTO_THREADID_hash
194returns a numeric value usable as a hash-table key.
195This is usually the exact numeric or pointer-based thread ID used
196internally, however this also handles the unusual case where pointers
197are larger than
198.Vt long
199variables and the platform's thread IDs are pointer-based \(em in
200this case, mixing is done to attempt to produce a unique numeric
201value even though it is not as wide as the platform's true thread
202IDs.
203.El
204.Pp
205Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
206of OpenSSL need it for better performance.
207To enable this, the following is required:
208.Bl -bullet
209.It
210Three additional callback functions,
211.Fn dyn_create_function ,
212.Fn dyn_lock_function ,
213and
214.Fn dyn_destroy_function .
215.It
216A structure defined with the data that each lock needs to handle.
217.El
218.Pp
219.Vt struct CRYPTO_dynlock_value
220has to be defined to contain whatever structure is needed to handle locks.
221.Pp
222.Fo dyn_create_function
223.Fa "const char *file"
224.Fa "int line"
225.Fc
226is needed to create a lock.
227Multi-threaded applications might crash at random if it is not set.
228.Pp
229.Fo dyn_lock_function
230.Fa "int mode"
231.Fa "CRYPTO_dynlock *l"
232.Fa "const char *file"
233.Fa "int line"
234.Fc
235is needed to perform locking off dynamic lock numbered n.
236Multi-threaded applications might crash at random if it is not set.
237.Pp
238.Fo dyn_destroy_function
239.Fa "CRYPTO_dynlock *l"
240.Fa "const char *file"
241.Fa "int line"
242.Fc
243is needed to destroy the lock
244.Fa l .
245Multi-threaded applications might crash at random if it is not set.
246.Pp
247.Fn CRYPTO_get_new_dynlockid
248is used to create locks.
249It will call
250.Fn dyn_create_function
251for the actual creation.
252.Pp
253.Fn CRYPTO_destroy_dynlockid
254is used to destroy locks.
255It will call
256.Fn dyn_destroy_function
257for the actual destruction.
258.Pp
259.Fn CRYPTO_lock
260is used to lock and unlock the locks.
261.Fa mode
262is a bitfield describing what should be done with the lock.
263.Fa n
264is the number of the lock as returned from
265.Fn CRYPTO_get_new_dynlockid .
266.Fa mode
267can be combined from the following values.
268These values are pairwise exclusive, with undefined behaviour if misused
269(for example,
270.Dv CRYPTO_READ
271and
272.Dv CRYPTO_WRITE
273should not be used together):
274.Bd -literal -offset indent
275CRYPTO_LOCK 0x01
276CRYPTO_UNLOCK 0x02
277CRYPTO_READ 0x04
278CRYPTO_WRITE 0x08
279.Ed
280.Sh RETURN VALUES
281.Fn CRYPTO_num_locks
282returns the required number of locks.
283.Pp
284.Fn CRYPTO_get_new_dynlockid
285returns the index to the newly created lock.
286.Pp
287The other functions return no values.
288.Sh NOTES
289You can find out if OpenSSL was configured with thread support:
290.Bd -literal -offset indent
291#define OPENSSL_THREAD_DEFINES
292#include <openssl/opensslconf.h>
293#if defined(OPENSSL_THREADS)
294 /* thread support enabled */
295#else
296 /* no thread support */
297#endif
298.Ed
299.Pp
300Also, dynamic locks are currently not used internally by OpenSSL, but
301may do so in the future.
302.Sh EXAMPLES
303.Pa crypto/threads/mttest.c
304shows examples of the callback functions on Solaris, Irix and Win32.
305.Sh SEE ALSO
306.Xr crypto 3
307.Sh HISTORY
308.Fn CRYPTO_set_locking_callback
309is available in all versions of SSLeay and OpenSSL.
310.Fn CRYPTO_num_locks
311was added in OpenSSL 0.9.4.
312All functions dealing with dynamic locks were added in OpenSSL 0.9.5b-dev.
313.Vt CRYPTO_THREADID
314and associated functions were introduced in OpenSSL 1.0.0 to replace
315(actually, deprecate) the previous
316.Fn CRYPTO_set_id_callback ,
317.Fn CRYPTO_get_id_callback ,
318and
319.Fn CRYPTO_thread_id
320functions which assumed thread IDs to always be represented by
321.Vt unsigned long .
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile
index 2c5ffbb8e4..ef5c1f9727 100644
--- a/src/lib/libcrypto/man/Makefile
+++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
1# $OpenBSD: Makefile,v 1.26 2015/11/11 18:36:48 schwarze Exp $ 1# $OpenBSD: Makefile,v 1.27 2015/11/11 21:15:15 schwarze Exp $
2 2
3.include <bsd.own.mk> # for NOMAN 3.include <bsd.own.mk> # for NOMAN
4 4
@@ -69,13 +69,14 @@ MAN= \
69 CMS_uncompress.3 \ 69 CMS_uncompress.3 \
70 CMS_verify.3 \ 70 CMS_verify.3 \
71 CMS_verify_receipt.3 \ 71 CMS_verify_receipt.3 \
72 EVP_AEAD_CTX_init.3 \
73
74GENMAN= \
75 CONF_modules_free.3 \ 72 CONF_modules_free.3 \
76 CONF_modules_load_file.3 \ 73 CONF_modules_load_file.3 \
77 CRYPTO_set_ex_data.3 \ 74 CRYPTO_set_ex_data.3 \
78 CRYPTO_set_locking_callback.3 \ 75 CRYPTO_set_locking_callback.3 \
76 EVP_AEAD_CTX_init.3 \
77 crypto.3 \
78
79GENMAN= \
79 DES_set_key.3 \ 80 DES_set_key.3 \
80 DH_generate_key.3 \ 81 DH_generate_key.3 \
81 DH_generate_parameters.3 \ 82 DH_generate_parameters.3 \
@@ -188,7 +189,6 @@ GENMAN= \
188 X509_verify_cert.3 \ 189 X509_verify_cert.3 \
189 bn.3 \ 190 bn.3 \
190 bn_internal.3 \ 191 bn_internal.3 \
191 crypto.3 \
192 d2i_ASN1_OBJECT.3 \ 192 d2i_ASN1_OBJECT.3 \
193 d2i_DHparams.3 \ 193 d2i_DHparams.3 \
194 d2i_DSAPublicKey.3 \ 194 d2i_DSAPublicKey.3 \
diff --git a/src/lib/libcrypto/man/crypto.3 b/src/lib/libcrypto/man/crypto.3
new file mode 100644
index 0000000000..24d4ed1979
--- /dev/null
+++ b/src/lib/libcrypto/man/crypto.3
@@ -0,0 +1,104 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CRYPTO 3
3.Os
4.Sh NAME
5.Nm crypto
6.Nd OpenSSL cryptographic library
7.Sh DESCRIPTION
8The OpenSSL crypto library implements a wide range of cryptographic
9algorithms used in various Internet standards.
10The services provided by this library are used by the OpenSSL
11implementations of SSL, TLS and S/MIME, and they have also been used to
12implement SSH, OpenPGP, and other cryptographic standards.
13.Sh OVERVIEW
14.Sy libcrypto
15consists of a number of sub-libraries that implement the individual
16algorithms.
17.Pp
18The functionality includes symmetric encryption, public key cryptography
19and key agreement, certificate handling, cryptographic hash functions
20and a cryptographic pseudo-random number generator.
21.Bl -tag -width Ds
22.It SYMMETRIC CIPHERS
23.Xr blowfish 3 ,
24cast,
25.Xr des 3 ,
26idea,
27rc2,
28.Xr rc4 3 ,
29rc5
30.It PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT
31.Xr dsa 3 ,
32.Xr dh 3 ,
33.Xr rsa 3
34.It CERTIFICATES
35.Xr x509 3 ,
36x509v3
37.It AUTHENTICATION CODES, HASH FUNCTIONS
38.Xr hmac 3 ,
39.Xr MD2 3 ,
40.Xr MD4 3 ,
41.Xr MD5 3 ,
42.Xr ripemd 3 ,
43.Xr sha 3
44.It AUXILIARY FUNCTIONS
45.Xr ERR 3 ,
46.Xr threads 3 ,
47.Xr rand 3 ,
48.Xr OPENSSL_VERSION_NUMBER 3
49.It INPUT/OUTPUT, DATA ENCODING
50asn1,
51.Xr bio 3 ,
52.Xr evp 3 ,
53.Xr pem 3 ,
54pkcs7,
55pkcs12
56.It INTERNAL FUNCTIONS
57.Xr bn 3 ,
58.Xr buffer 3 ,
59.Xr ec 3 ,
60.Xr lhash 3 ,
61objects,
62stack,
63txt_db
64.El
65.Sh NOTES
66Some of the newer functions follow a naming convention using the numbers
67.Sq 0
68and
69.Sq 1 .
70For example the functions:
71.Pp
72.Ft int
73.Fo X509_CRL_add0_revoked
74.Fa "X509_CRL *crl"
75.Fa "X509_REVOKED *rev"
76.Fc
77.br
78.Ft int
79.Fo X509_add1_trust_object
80.Fa "X509 *x"
81.Fa "ASN1_OBJECT *obj"
82.Fc
83.Pp
84The
85.Sq 0
86version uses the supplied structure pointer directly in the parent and
87it will be freed up when the parent is freed.
88In the above example
89.Fa crl
90would be freed but
91.Fa rev
92would not.
93.Pp
94The
95.Sq 1
96function uses a copy of the supplied structure pointer (or in some cases
97increases its link count) in the parent and so both
98.Pf ( Fa x
99and
100.Fa obj
101above) should be freed up.
102.Sh SEE ALSO
103.Xr openssl 1 ,
104.Xr ssl 3
diff --git a/src/lib/libssl/src/doc/crypto/CONF_modules_free.pod b/src/lib/libssl/src/doc/crypto/CONF_modules_free.pod
deleted file mode 100644
index 803b2faab1..0000000000
--- a/src/lib/libssl/src/doc/crypto/CONF_modules_free.pod
+++ /dev/null
@@ -1,47 +0,0 @@
1=pod
2
3=head1 NAME
4
5CONF_modules_free, CONF_modules_finish, CONF_modules_unload - OpenSSL
6configuration cleanup functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/conf.h>
11
12 void CONF_modules_free(void);
13 void CONF_modules_finish(void);
14 void CONF_modules_unload(int all);
15
16=head1 DESCRIPTION
17
18CONF_modules_free() closes down and frees up all memory allocated by all
19configuration modules.
20
21CONF_modules_finish() calls each configuration modules B<finish> handler
22to free up any configuration that module may have performed.
23
24CONF_modules_unload() finishes and unloads configuration modules. If
25B<all> is set to B<0> only modules loaded from DSOs will be unloads. If
26B<all> is B<1> all modules, including builtin modules will be unloaded.
27
28=head1 NOTES
29
30Normally applications will only call CONF_modules_free() at application to
31tidy up any configuration performed.
32
33=head1 RETURN VALUE
34
35None of the functions return a value.
36
37=head1 SEE ALSO
38
39L<conf(5)|conf(5)>, L<OPENSSL_config(3)|OPENSSL_config(3)>,
40L<CONF_modules_load_file(3)|CONF_modules_load_file(3)>
41
42=head1 HISTORY
43
44CONF_modules_free(), CONF_modules_unload(), and CONF_modules_finish()
45first appeared in OpenSSL 0.9.7.
46
47=cut
diff --git a/src/lib/libssl/src/doc/crypto/CONF_modules_load_file.pod b/src/lib/libssl/src/doc/crypto/CONF_modules_load_file.pod
deleted file mode 100644
index e663ac5bc9..0000000000
--- a/src/lib/libssl/src/doc/crypto/CONF_modules_load_file.pod
+++ /dev/null
@@ -1,60 +0,0 @@
1=pod
2
3=head1 NAME
4
5CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions
6
7=head1 SYNOPSIS
8
9 #include <openssl/conf.h>
10
11 int CONF_modules_load_file(const char *filename, const char *appname,
12 unsigned long flags);
13 int CONF_modules_load(const CONF *cnf, const char *appname,
14 unsigned long flags);
15
16=head1 DESCRIPTION
17
18The function CONF_modules_load_file() configures OpenSSL using file
19B<filename> and application name B<appname>. If B<filename> is NULL
20the standard OpenSSL configuration file is used. If B<appname> is
21NULL the standard OpenSSL application name B<openssl_conf> is used.
22The behaviour can be customized using B<flags>.
23
24CONF_modules_load() is identical to CONF_modules_load_file() except it
25read configuration information from B<cnf>.
26
27=head1 NOTES
28
29The following B<flags> are currently recognized:
30
31B<CONF_MFLAGS_IGNORE_ERRORS> if set errors returned by individual
32configuration modules are ignored. If not set the first module error is
33considered fatal and no further modules are loads.
34
35Normally any modules errors will add error information to the error queue. If
36B<CONF_MFLAGS_SILENT> is set no error information is added.
37
38If B<CONF_MFLAGS_NO_DSO> is set configuration module loading from DSOs is
39disabled.
40
41B<CONF_MFLAGS_IGNORE_MISSING_FILE> if set will make CONF_load_modules_file()
42ignore missing configuration files. Normally a missing configuration file
43return an error.
44
45=head1 RETURN VALUE
46
47These functions return 1 for success and a zero or negative value for
48failure. If module errors are not ignored the return code will reflect the
49return value of the failing module (this will always be zero or negative).
50
51=head1 SEE ALSO
52
53L<conf(5)|conf(5)>, L<OPENSSL_config(3)|OPENSSL_config(3)>,
54L<CONF_free(3)|CONF_free(3)>, L<err(3)|err(3)>
55
56=head1 HISTORY
57
58CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.
59
60=cut
diff --git a/src/lib/libssl/src/doc/crypto/CRYPTO_set_ex_data.pod b/src/lib/libssl/src/doc/crypto/CRYPTO_set_ex_data.pod
deleted file mode 100644
index 0c8b378854..0000000000
--- a/src/lib/libssl/src/doc/crypto/CRYPTO_set_ex_data.pod
+++ /dev/null
@@ -1,56 +0,0 @@
1=pod
2
3=head1 NAME
4
5CRYPTO_set_ex_data, CRYPTO_get_ex_data - internal application specific data
6functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/crypto.h>
11
12 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *r, int idx, void *arg);
13
14 void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *r, int idx);
15
16=head1 DESCRIPTION
17
18Several OpenSSL structures can have application specific data attached to them.
19These functions are used internally by OpenSSL to manipulate application
20specific data attached to a specific structure.
21
22These functions should only be used by applications to manipulate
23B<CRYPTO_EX_DATA> structures passed to the B<new_func()>, B<free_func()> and
24B<dup_func()> callbacks: as passed to B<RSA_get_ex_new_index()> for example.
25
26B<CRYPTO_set_ex_data()> is used to set application specific data, the data is
27supplied in the B<arg> parameter and its precise meaning is up to the
28application.
29
30B<CRYPTO_get_ex_data()> is used to retrieve application specific data. The data
31is returned to the application, this will be the same value as supplied to
32a previous B<CRYPTO_set_ex_data()> call.
33
34=head1 RETURN VALUES
35
36B<CRYPTO_set_ex_data()> returns 1 on success or 0 on failure.
37
38B<CRYPTO_get_ex_data()> returns the application data or 0 on failure. 0 may
39also be valid application data but currently it can only fail if given an
40invalid B<idx> parameter.
41
42On failure an error code can be obtained from
43L<ERR_get_error(3)|ERR_get_error(3)>.
44
45=head1 SEE ALSO
46
47L<RSA_get_ex_new_index(3)|RSA_get_ex_new_index(3)>,
48L<DSA_get_ex_new_index(3)|DSA_get_ex_new_index(3)>,
49L<DH_get_ex_new_index(3)|DH_get_ex_new_index(3)>
50
51=head1 HISTORY
52
53CRYPTO_set_ex_data() and CRYPTO_get_ex_data() have been available since SSLeay
540.9.0.
55
56=cut
diff --git a/src/lib/libssl/src/doc/crypto/CRYPTO_set_locking_callback.pod b/src/lib/libssl/src/doc/crypto/CRYPTO_set_locking_callback.pod
deleted file mode 100644
index 8f4cf4cb2d..0000000000
--- a/src/lib/libssl/src/doc/crypto/CRYPTO_set_locking_callback.pod
+++ /dev/null
@@ -1,210 +0,0 @@
1=pod
2
3=head1 NAME
4
5CRYPTO_THREADID_set_callback, CRYPTO_THREADID_get_callback,
6CRYPTO_THREADID_current, CRYPTO_THREADID_cmp, CRYPTO_THREADID_cpy,
7CRYPTO_THREADID_hash, CRYPTO_set_locking_callback, CRYPTO_num_locks,
8CRYPTO_set_dynlock_create_callback, CRYPTO_set_dynlock_lock_callback,
9CRYPTO_set_dynlock_destroy_callback, CRYPTO_get_new_dynlockid,
10CRYPTO_destroy_dynlockid, CRYPTO_lock - OpenSSL thread support
11
12=head1 SYNOPSIS
13
14 #include <openssl/crypto.h>
15
16 /* Don't use this structure directly. */
17 typedef struct crypto_threadid_st
18 {
19 void *ptr;
20 unsigned long val;
21 } CRYPTO_THREADID;
22 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
23 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
24 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
25 int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *));
26 void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *);
27 void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
28 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a,
29 const CRYPTO_THREADID *b);
30 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest,
31 const CRYPTO_THREADID *src);
32 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
33
34 int CRYPTO_num_locks(void);
35
36 /* struct CRYPTO_dynlock_value needs to be defined by the user */
37 struct CRYPTO_dynlock_value;
38
39 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *
40 (*dyn_create_function)(char *file, int line));
41 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
42 (int mode, struct CRYPTO_dynlock_value *l,
43 const char *file, int line));
44 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
45 (struct CRYPTO_dynlock_value *l, const char *file, int line));
46
47 int CRYPTO_get_new_dynlockid(void);
48
49 void CRYPTO_destroy_dynlockid(int i);
50
51 void CRYPTO_lock(int mode, int n, const char *file, int line);
52
53 #define CRYPTO_w_lock(type) \
54 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
55 #define CRYPTO_w_unlock(type) \
56 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
57 #define CRYPTO_r_lock(type) \
58 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
59 #define CRYPTO_r_unlock(type) \
60 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
61 #define CRYPTO_add(addr,amount,type) \
62 CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
63
64=head1 DESCRIPTION
65
66OpenSSL can safely be used in multi-threaded applications provided
67that at least two callback functions are set, locking_function and
68threadid_func.
69
70locking_function(int mode, int n, const char *file, int line) is
71needed to perform locking on shared data structures.
72(Note that OpenSSL uses a number of global data structures that
73will be implicitly shared whenever multiple threads use OpenSSL.)
74Multi-threaded applications will crash at random if it is not set.
75
76locking_function() must be able to handle up to CRYPTO_num_locks()
77different mutex locks. It sets the B<n>-th lock if B<mode> &
78B<CRYPTO_LOCK>, and releases it otherwise.
79
80B<file> and B<line> are the file number of the function setting the
81lock. They can be useful for debugging.
82
83threadid_func(CRYPTO_THREADID *id) is needed to record the currently-executing
84thread's identifier into B<id>. The implementation of this callback should not
85fill in B<id> directly, but should use CRYPTO_THREADID_set_numeric() if thread
86IDs are numeric, or CRYPTO_THREADID_set_pointer() if they are pointer-based.
87If the application does not register such a callback using
88CRYPTO_THREADID_set_callback(), then a default implementation is used - on
89Windows and BeOS this uses the system's default thread identifying APIs, and on
90all other platforms it uses the address of B<errno>. The latter is satisfactory
91for thread-safety if and only if the platform has a thread-local error number
92facility.
93
94Once threadid_func() is registered, or if the built-in default implementation is
95to be used;
96
97=over 4
98
99=item *
100CRYPTO_THREADID_current() records the currently-executing thread ID into the
101given B<id> object.
102
103=item *
104CRYPTO_THREADID_cmp() compares two thread IDs (returning zero for equality, ie.
105the same semantics as memcmp()).
106
107=item *
108CRYPTO_THREADID_cpy() duplicates a thread ID value,
109
110=item *
111CRYPTO_THREADID_hash() returns a numeric value usable as a hash-table key. This
112is usually the exact numeric or pointer-based thread ID used internally, however
113this also handles the unusual case where pointers are larger than 'long'
114variables and the platform's thread IDs are pointer-based - in this case, mixing
115is done to attempt to produce a unique numeric value even though it is not as
116wide as the platform's true thread IDs.
117
118=back
119
120Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
121of OpenSSL need it for better performance. To enable this, the following
122is required:
123
124=over 4
125
126=item *
127Three additional callback function, dyn_create_function, dyn_lock_function
128and dyn_destroy_function.
129
130=item *
131A structure defined with the data that each lock needs to handle.
132
133=back
134
135struct CRYPTO_dynlock_value has to be defined to contain whatever structure
136is needed to handle locks.
137
138dyn_create_function(const char *file, int line) is needed to create a
139lock. Multi-threaded applications might crash at random if it is not set.
140
141dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
142is needed to perform locking off dynamic lock numbered n. Multi-threaded
143applications might crash at random if it is not set.
144
145dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
146needed to destroy the lock l. Multi-threaded applications might crash at
147random if it is not set.
148
149CRYPTO_get_new_dynlockid() is used to create locks. It will call
150dyn_create_function for the actual creation.
151
152CRYPTO_destroy_dynlockid() is used to destroy locks. It will call
153dyn_destroy_function for the actual destruction.
154
155CRYPTO_lock() is used to lock and unlock the locks. mode is a bitfield
156describing what should be done with the lock. n is the number of the
157lock as returned from CRYPTO_get_new_dynlockid(). mode can be combined
158from the following values. These values are pairwise exclusive, with
159undefined behaviour if misused (for example, CRYPTO_READ and CRYPTO_WRITE
160should not be used together):
161
162 CRYPTO_LOCK 0x01
163 CRYPTO_UNLOCK 0x02
164 CRYPTO_READ 0x04
165 CRYPTO_WRITE 0x08
166
167=head1 RETURN VALUES
168
169CRYPTO_num_locks() returns the required number of locks.
170
171CRYPTO_get_new_dynlockid() returns the index to the newly created lock.
172
173The other functions return no values.
174
175=head1 NOTES
176
177You can find out if OpenSSL was configured with thread support:
178
179 #define OPENSSL_THREAD_DEFINES
180 #include <openssl/opensslconf.h>
181 #if defined(OPENSSL_THREADS)
182 // thread support enabled
183 #else
184 // no thread support
185 #endif
186
187Also, dynamic locks are currently not used internally by OpenSSL, but
188may do so in the future.
189
190=head1 EXAMPLES
191
192B<crypto/threads/mttest.c> shows examples of the callback functions on
193Solaris, Irix and Win32.
194
195=head1 HISTORY
196
197CRYPTO_set_locking_callback() is
198available in all versions of SSLeay and OpenSSL.
199CRYPTO_num_locks() was added in OpenSSL 0.9.4.
200All functions dealing with dynamic locks were added in OpenSSL 0.9.5b-dev.
201B<CRYPTO_THREADID> and associated functions were introduced in OpenSSL 1.0.0
202to replace (actually, deprecate) the previous CRYPTO_set_id_callback(),
203CRYPTO_get_id_callback(), and CRYPTO_thread_id() functions which assumed
204thread IDs to always be represented by 'unsigned long'.
205
206=head1 SEE ALSO
207
208L<crypto(3)|crypto(3)>
209
210=cut
diff --git a/src/lib/libssl/src/doc/crypto/crypto.pod b/src/lib/libssl/src/doc/crypto/crypto.pod
deleted file mode 100644
index bbd6ce9ea9..0000000000
--- a/src/lib/libssl/src/doc/crypto/crypto.pod
+++ /dev/null
@@ -1,85 +0,0 @@
1=pod
2
3=head1 NAME
4
5crypto - OpenSSL cryptographic library
6
7=head1 SYNOPSIS
8
9=head1 DESCRIPTION
10
11The OpenSSL B<crypto> library implements a wide range of cryptographic
12algorithms used in various Internet standards. The services provided
13by this library are used by the OpenSSL implementations of SSL, TLS
14and S/MIME, and they have also been used to implement SSH, OpenPGP, and
15other cryptographic standards.
16
17=head1 OVERVIEW
18
19B<libcrypto> consists of a number of sub-libraries that implement the
20individual algorithms.
21
22The functionality includes symmetric encryption, public key
23cryptography and key agreement, certificate handling, cryptographic
24hash functions and a cryptographic pseudo-random number generator.
25
26=over 4
27
28=item SYMMETRIC CIPHERS
29
30L<blowfish(3)|blowfish(3)>, L<cast(3)|cast(3)>, L<des(3)|des(3)>,
31L<idea(3)|idea(3)>, L<rc2(3)|rc2(3)>, L<rc4(3)|rc4(3)>, L<rc5(3)|rc5(3)>
32
33=item PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT
34
35L<dsa(3)|dsa(3)>, L<dh(3)|dh(3)>, L<rsa(3)|rsa(3)>
36
37=item CERTIFICATES
38
39L<x509(3)|x509(3)>, L<x509v3(3)|x509v3(3)>
40
41=item AUTHENTICATION CODES, HASH FUNCTIONS
42
43L<hmac(3)|hmac(3)>, L<md2(3)|md2(3)>, L<md4(3)|md4(3)>,
44L<md5(3)|md5(3)>, L<ripemd(3)|ripemd(3)>,
45L<sha(3)|sha(3)>
46
47=item AUXILIARY FUNCTIONS
48
49L<err(3)|err(3)>, L<threads(3)|threads(3)>, L<rand(3)|rand(3)>,
50L<OPENSSL_VERSION_NUMBER(3)|OPENSSL_VERSION_NUMBER(3)>
51
52=item INPUT/OUTPUT, DATA ENCODING
53
54L<asn1(3)|asn1(3)>, L<bio(3)|bio(3)>, L<evp(3)|evp(3)>, L<pem(3)|pem(3)>,
55L<pkcs7(3)|pkcs7(3)>, L<pkcs12(3)|pkcs12(3)>
56
57=item INTERNAL FUNCTIONS
58
59L<bn(3)|bn(3)>, L<buffer(3)|buffer(3)>, L<ec(3)|ec(3)>, L<lhash(3)|lhash(3)>,
60L<objects(3)|objects(3)>, L<stack(3)|stack(3)>,
61L<txt_db(3)|txt_db(3)>
62
63=back
64
65=head1 NOTES
66
67Some of the newer functions follow a naming convention using the numbers
68B<0> and B<1>. For example the functions:
69
70 int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
71 int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj);
72
73The B<0> version uses the supplied structure pointer directly
74in the parent and it will be freed up when the parent is freed.
75In the above example B<crl> would be freed but B<rev> would not.
76
77The B<1> function uses a copy of the supplied structure pointer
78(or in some cases increases its link count) in the parent and
79so both (B<x> and B<obj> above) should be freed up.
80
81=head1 SEE ALSO
82
83L<openssl(1)|openssl(1)>, L<ssl(3)|ssl(3)>
84
85=cut