summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.3
diff options
context:
space:
mode:
authorbentley <>2014-10-12 09:33:04 +0000
committerbentley <>2014-10-12 09:33:04 +0000
commit82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch)
treea5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.3
parent0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff)
downloadopenbsd-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_SESSION_get_ex_new_index.3')
-rw-r--r--src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.377
1 files changed, 77 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.3 b/src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.3
new file mode 100644
index 0000000000..d6a94cb0b7
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_SESSION_get_ex_new_index.3
@@ -0,0 +1,77 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_SESSION_GET_EX_NEW_INDEX 3
3.Os
4.Sh NAME
5.Nm SSL_SESSION_get_ex_new_index ,
6.Nm SSL_SESSION_set_ex_data ,
7.Nm SSL_SESSION_get_ex_data
8.Nd internal application specific data functions
9.Sh SYNOPSIS
10.In openssl/ssl.h
11.Ft int
12.Fo SSL_SESSION_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_SESSION_set_ex_data "SSL_SESSION *session" "int idx" "void *arg"
21.Ft void *
22.Fn SSL_SESSION_get_ex_data "const SSL_SESSION *session" "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
32Several OpenSSL structures can have application specific data attached to them.
33These functions are used internally by OpenSSL to manipulate
34application-specific data attached to a specific structure.
35.Pp
36.Fn SSL_SESSION_get_ex_new_index
37is used to register a new index for application-specific data.
38.Pp
39.Fn SSL_SESSION_set_ex_data
40is used to store application data at
41.Fa arg
42for
43.Fa idx
44into the
45.Fa session
46object.
47.Pp
48.Fn SSL_SESSION_get_ex_data
49is used to retrieve the information for
50.Fa idx
51from
52.Fa session .
53.Pp
54A detailed description for the
55.Fn *_get_ex_new_index
56functionality
57can be found in
58.Xr RSA_get_ex_new_index 3 .
59The
60.Fn *_get_ex_data
61and
62.Fn *_set_ex_data
63functionality is described in
64.Xr CRYPTO_set_ex_data 3 .
65.Sh WARNINGS
66The application data is only maintained for sessions held in memory.
67The application data is not included when dumping the session with
68.Xr i2d_SSL_SESSION 3
69(and all functions indirectly calling the dump functions like
70.Xr PEM_write_SSL_SESSION 3
71and
72.Xr PEM_write_bio_SSL_SESSION 3 )
73and can therefore not be restored.
74.Sh SEE ALSO
75.Xr CRYPTO_set_ex_data 3 ,
76.Xr RSA_get_ex_new_index 3 ,
77.Xr ssl 3