diff options
author | schwarze <> | 2015-11-11 21:15:15 +0000 |
---|---|---|
committer | schwarze <> | 2015-11-11 21:15:15 +0000 |
commit | 22f89c8c27130dce389c2cba215b4cdd0deadd22 (patch) | |
tree | df165a08270ef8df757ccda21dbd1c609633bd3f /src/lib/libcrypto/man/CRYPTO_set_ex_data.3 | |
parent | 0241f6701aac0e95428b9f0899b07ba086aa7e71 (diff) | |
download | openbsd-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/libcrypto/man/CRYPTO_set_ex_data.3')
-rw-r--r-- | src/lib/libcrypto/man/CRYPTO_set_ex_data.3 | 70 |
1 files changed, 70 insertions, 0 deletions
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 | ||
22 | Several OpenSSL structures can have application specific data attached | ||
23 | to them. | ||
24 | These functions are used internally by OpenSSL to manipulate application | ||
25 | specific data attached to a specific structure. | ||
26 | .Pp | ||
27 | These functions should only be used by applications to manipulate | ||
28 | .Vt CRYPTO_EX_DATA | ||
29 | structures passed to the | ||
30 | .Fn new_func , | ||
31 | .Fn free_func , | ||
32 | and | ||
33 | .Fn dup_func | ||
34 | callbacks: as passed to | ||
35 | .Xr RSA_get_ex_new_index 3 | ||
36 | for example. | ||
37 | .Pp | ||
38 | .Fn CRYPTO_set_ex_data | ||
39 | is used to set application specific data, the data is supplied in the | ||
40 | .Fa arg | ||
41 | parameter and its precise meaning is up to the application. | ||
42 | .Pp | ||
43 | .Fn CRYPTO_get_ex_data | ||
44 | is used to retrieve application specific data. | ||
45 | The data is returned to the application, this will be the same value as | ||
46 | supplied to a previous | ||
47 | .Fn CRYPTO_set_ex_data | ||
48 | call. | ||
49 | .Sh RETURN VALUES | ||
50 | .Fn CRYPTO_set_ex_data | ||
51 | returns 1 on success or 0 on failure. | ||
52 | .Pp | ||
53 | .Fn CRYPTO_get_ex_data | ||
54 | returns the application data or 0 on failure. | ||
55 | 0 may also be valid application data but currently it can only fail if | ||
56 | given an invalid | ||
57 | .Fa idx | ||
58 | parameter. | ||
59 | .Pp | ||
60 | On 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 | ||
68 | and | ||
69 | .Fn CRYPTO_get_ex_data | ||
70 | have been available since SSLeay 0.9.0. | ||