diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_ex_new_index.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_ex_new_index.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_get_ex_new_index.3 | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_ex_new_index.3 b/src/lib/libssl/doc/SSL_get_ex_new_index.3 new file mode 100644 index 0000000000..5b1ff19c54 --- /dev/null +++ b/src/lib/libssl/doc/SSL_get_ex_new_index.3 | |||
@@ -0,0 +1,73 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_GET_EX_NEW_INDEX 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_get_ex_new_index , | ||
6 | .Nm SSL_set_ex_data , | ||
7 | .Nm SSL_get_ex_data | ||
8 | .Nd internal application specific data functions | ||
9 | .Sh SYNOPSIS | ||
10 | .In openssl/ssl.h | ||
11 | .Ft int | ||
12 | .Fo SSL_get_ex_new_index | ||
13 | .Fa "long argl" | ||
14 | .Fa "void *argp" | ||
15 | .Fa "CRYPTO_EX_new *new_func" | ||
16 | .Fa "CRYPTO_EX_dup *dup_func" | ||
17 | .Fa "CRYPTO_EX_free *free_func" | ||
18 | .Fc | ||
19 | .Ft int | ||
20 | .Fn SSL_set_ex_data "SSL *ssl" "int idx" "void *arg" | ||
21 | .Ft void * | ||
22 | .Fn SSL_get_ex_data "const SSL *ssl" "int idx" | ||
23 | .Bd -literal | ||
24 | typedef int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad, | ||
25 | int idx, long argl, void *argp); | ||
26 | typedef void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad, | ||
27 | int idx, long argl, void *argp); | ||
28 | typedef int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, | ||
29 | int idx, long argl, void *argp); | ||
30 | .Ed | ||
31 | .Sh DESCRIPTION | ||
32 | Several OpenSSL structures can have application specific data attached to them. | ||
33 | These functions are used internally by OpenSSL to manipulate application | ||
34 | specific data attached to a specific structure. | ||
35 | .Pp | ||
36 | .Fn SSL_get_ex_new_index | ||
37 | is used to register a new index for application specific data. | ||
38 | .Pp | ||
39 | .Fn SSL_set_ex_data | ||
40 | is used to store application data at | ||
41 | .Fa arg | ||
42 | for | ||
43 | .Fa idx | ||
44 | into the | ||
45 | .Fa ssl | ||
46 | object. | ||
47 | .Pp | ||
48 | .Fn SSL_get_ex_data | ||
49 | is used to retrieve the information for | ||
50 | .Fa idx | ||
51 | from | ||
52 | .Fa ssl . | ||
53 | .Pp | ||
54 | A detailed description for the | ||
55 | .Fn *_get_ex_new_index | ||
56 | functionality can be found in | ||
57 | .Xr RSA_get_ex_new_index 3 . | ||
58 | The | ||
59 | .Fn *_get_ex_data | ||
60 | and | ||
61 | .Fn *_set_ex_data | ||
62 | functionality is described in | ||
63 | .Xr CRYPTO_set_ex_data 3 . | ||
64 | .Sh EXAMPLES | ||
65 | An example of how to use the functionality is included in the example | ||
66 | .Fn verify_callback | ||
67 | in | ||
68 | .Xr SSL_CTX_set_verify 3 . | ||
69 | .Sh SEE ALSO | ||
70 | .Xr CRYPTO_set_ex_data 3 , | ||
71 | .Xr RSA_get_ex_new_index 3 , | ||
72 | .Xr ssl 3 , | ||
73 | .Xr SSL_CTX_set_verify 3 | ||