30900d92584a819c22e7d94df080b2a7ca37f254
[openssl.git] / doc / crypto / RSA_get_ex_new_index.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specific data to RSA structures.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rsa.h>
10
11  int RSA_get_ex_new_index(long argl, void *argp,
12                 CRYPTO_EX_new *new_func,
13                 CRYPTO_EX_dup *dup_func,
14                 CRYPTO_EX_free *free_func);
15
16  int RSA_set_ex_data(RSA *r,int idx,void *arg);
17
18  void *RSA_get_ex_data(RSA *r, int idx);
19
20  int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
21                                         int idx, long argl, void *argp);
22
23  void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
24                                         int idx, long argl, void *argp);
25  int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
26                                         int idx, long argl, void *argp);
27
28
29
30 =head1 DESCRIPTION
31
32 Several OpenSSL structures can have application specific data attached to them.
33 This has several potential uses, it can be used to cache data associated with
34 a structure (for example the hash of some part of the structure) or some
35 additional data (for example a handle to the data in an external library).
36
37 Since the application data can be anything at all it is passed and retrieved
38 as a B<void *> type.
39
40 The B<RSA_get_ex_new_index()> function is initially called to "register" some
41 new application specific data. It takes three optional function pointers which
42 are called when the parent structure (in this case an RSA structure) is
43 initially created, when it is copied and when it is freed up. If any or all of
44 these function pointer arguments are not used they should be set to NULL. The
45 precise manner in which these function pointer are called is described in more
46 detail below. B<RSA_get_ex_new_index()> also takes additional long and pointer
47 parameters which will be passed to the supplied functions but which otherwise
48 have no special meaning. It returns an B<index> which should be stored
49 (typically in a static variable) and passed used in the B<idx> parameter in
50 the remaining functions. Each successful call to B<RSA_get_ex_new_index()>
51 will return an index greater than any previously returned, this is important
52 because the optional functions are called in order of increasing index value.
53
54 B<RSA_set_ex_data()> is used to set application specific data, the data is
55 supplied in the B<arg> parameter and its precise meaning is up to the
56 application.
57
58 B<RSA_get_ex_data()> is used to retrieve application specific data. The data
59 is returned to the application, this will be the same value as supplied to
60 a previous B<RSA_set_ex_data()> call.
61
62 B<new_func()> is called when a structure is initially allocated (for example
63 with B<RSA_new()>. The parent structure members will not have any meaningful
64 values at this point. This function will typically be used to allocate any
65 application specific structure.
66
67 B<free_func()> is called when a structure is being freed up. The dynamic parent
68 structure members should not be accessed because they will be freed up when
69 this function is called.
70
71 B<new_func()> and B<free_func()> take the same parameters. B<parent> is a
72 pointer to the parent RSA structure. B<ptr> is a the application specific data
73 (this wont be of much use in B<new_func()>. B<ad> is a pointer to the
74 B<CRYPTO_EX_DATA> structure from the parent RSA structure: the functions
75 B<CRYPTO_get_ex_data()> and B<CRYPTO_get_ex_data()> can be called to manipulate
76 it. The B<idx> parameter is the index: this will be the same value returned by
77 B<RSA_get_ex_new_index()> when the functions were initially registered. Finally
78 the B<argl> and B<argp> parameters are the values originally passed to the same
79 corresponding parameters when B<RSA_get_ex_new_index()> was called.
80
81 B<dup_func()> is called when a structure is being copied. Pointers to the
82 destination and source B<CRYPTO_EX_DATA> structures are passed in the B<to> and
83 B<from> parameters respectively. The B<from_d> parameter is passed a pointer to
84 the source application data when the function is called, when the function returns
85 the value is copied to the destination: the application can thus modify the data
86 pointed to by B<from_d> and have different values in the source and destination.
87 The B<idx>, B<argl> and B<argp> parameters are the same as those in B<new_func()>
88 and B<free_func()>.
89
90 =head1 RETURN VALUES
91
92 B<RSA_get_ex_new_index()> returns a new index or -1 on failure (note 0 is a valid
93 index value).
94
95 B<RSA_set_ex_data()> returns 1 on success or 0 on failure.
96
97 B<RSA_get_ex_data()> returns the application data or 0 on failure. 0 may also
98 be valid application data but currently it can only fail if given an invalid B<idx>
99 parameter.
100
101 B<new_func()> and B<dup_func()> should return 0 for failure and 1 for success.
102
103 On failure an error code can be obtained from L<ERR_get_error(3)|ERR_get_error(3)>.
104
105 =head1 BUGS
106
107 B<dup_func()> is currently never called.
108
109 The return value of B<new_func()> is ignored.
110
111 The B<new_func()> function isn't very useful because no meaningful values are
112 present in the parent RSA structure when it is called.
113
114 =head1 SEE ALSO
115
116 ...
117
118 =head1 HISTORY
119
120 ...
121
122 =cut