openssl: Adjust manual pages for 1.0.1o.
[dragonfly.git] / secure / lib / libcrypto / man / RSA_get_ex_new_index.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "RSA_get_ex_new_index 3"
136 .TH RSA_get_ex_new_index 3 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data \- add application specific data to RSA structures
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/rsa.h>
147 \&
148 \& int RSA_get_ex_new_index(long argl, void *argp,
149 \&                CRYPTO_EX_new *new_func,
150 \&                CRYPTO_EX_dup *dup_func,
151 \&                CRYPTO_EX_free *free_func);
152 \&
153 \& int RSA_set_ex_data(RSA *r, int idx, void *arg);
154 \&
155 \& void *RSA_get_ex_data(RSA *r, int idx);
156 \&
157 \& typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
158 \&                           int idx, long argl, void *argp);
159 \& typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
160 \&                             int idx, long argl, void *argp);
161 \& typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
162 \&                           int idx, long argl, void *argp);
163 .Ve
164 .SH "DESCRIPTION"
165 .IX Header "DESCRIPTION"
166 Several OpenSSL structures can have application specific data attached to them.
167 This has several potential uses, it can be used to cache data associated with
168 a structure (for example the hash of some part of the structure) or some
169 additional data (for example a handle to the data in an external library).
170 .PP
171 Since the application data can be anything at all it is passed and retrieved
172 as a \fBvoid *\fR type.
173 .PP
174 The \fB\f(BIRSA_get_ex_new_index()\fB\fR function is initially called to \*(L"register\*(R" some
175 new application specific data. It takes three optional function pointers which
176 are called when the parent structure (in this case an \s-1RSA\s0 structure) is
177 initially created, when it is copied and when it is freed up. If any or all of
178 these function pointer arguments are not used they should be set to \s-1NULL.\s0 The
179 precise manner in which these function pointers are called is described in more
180 detail below. \fB\f(BIRSA_get_ex_new_index()\fB\fR also takes additional long and pointer
181 parameters which will be passed to the supplied functions but which otherwise
182 have no special meaning. It returns an \fBindex\fR which should be stored
183 (typically in a static variable) and passed used in the \fBidx\fR parameter in
184 the remaining functions. Each successful call to \fB\f(BIRSA_get_ex_new_index()\fB\fR
185 will return an index greater than any previously returned, this is important
186 because the optional functions are called in order of increasing index value.
187 .PP
188 \&\fB\f(BIRSA_set_ex_data()\fB\fR is used to set application specific data, the data is
189 supplied in the \fBarg\fR parameter and its precise meaning is up to the
190 application.
191 .PP
192 \&\fB\f(BIRSA_get_ex_data()\fB\fR is used to retrieve application specific data. The data
193 is returned to the application, this will be the same value as supplied to
194 a previous \fB\f(BIRSA_set_ex_data()\fB\fR call.
195 .PP
196 \&\fB\f(BInew_func()\fB\fR is called when a structure is initially allocated (for example
197 with \fB\f(BIRSA_new()\fB\fR. The parent structure members will not have any meaningful
198 values at this point. This function will typically be used to allocate any
199 application specific structure.
200 .PP
201 \&\fB\f(BIfree_func()\fB\fR is called when a structure is being freed up. The dynamic parent
202 structure members should not be accessed because they will be freed up when
203 this function is called.
204 .PP
205 \&\fB\f(BInew_func()\fB\fR and \fB\f(BIfree_func()\fB\fR take the same parameters. \fBparent\fR is a
206 pointer to the parent \s-1RSA\s0 structure. \fBptr\fR is a the application specific data
207 (this wont be of much use in \fB\f(BInew_func()\fB\fR. \fBad\fR is a pointer to the
208 \&\fB\s-1CRYPTO_EX_DATA\s0\fR structure from the parent \s-1RSA\s0 structure: the functions
209 \&\fB\f(BICRYPTO_get_ex_data()\fB\fR and \fB\f(BICRYPTO_set_ex_data()\fB\fR can be called to manipulate
210 it. The \fBidx\fR parameter is the index: this will be the same value returned by
211 \&\fB\f(BIRSA_get_ex_new_index()\fB\fR when the functions were initially registered. Finally
212 the \fBargl\fR and \fBargp\fR parameters are the values originally passed to the same
213 corresponding parameters when \fB\f(BIRSA_get_ex_new_index()\fB\fR was called.
214 .PP
215 \&\fB\f(BIdup_func()\fB\fR is called when a structure is being copied. Pointers to the
216 destination and source \fB\s-1CRYPTO_EX_DATA\s0\fR structures are passed in the \fBto\fR and
217 \&\fBfrom\fR parameters respectively. The \fBfrom_d\fR parameter is passed a pointer to
218 the source application data when the function is called, when the function returns
219 the value is copied to the destination: the application can thus modify the data
220 pointed to by \fBfrom_d\fR and have different values in the source and destination.
221 The \fBidx\fR, \fBargl\fR and \fBargp\fR parameters are the same as those in \fB\f(BInew_func()\fB\fR
222 and \fB\f(BIfree_func()\fB\fR.
223 .SH "RETURN VALUES"
224 .IX Header "RETURN VALUES"
225 \&\fB\f(BIRSA_get_ex_new_index()\fB\fR returns a new index or \-1 on failure (note 0 is a valid
226 index value).
227 .PP
228 \&\fB\f(BIRSA_set_ex_data()\fB\fR returns 1 on success or 0 on failure.
229 .PP
230 \&\fB\f(BIRSA_get_ex_data()\fB\fR returns the application data or 0 on failure. 0 may also
231 be valid application data but currently it can only fail if given an invalid \fBidx\fR
232 parameter.
233 .PP
234 \&\fB\f(BInew_func()\fB\fR and \fB\f(BIdup_func()\fB\fR should return 0 for failure and 1 for success.
235 .PP
236 On failure an error code can be obtained from \fIERR_get_error\fR\|(3).
237 .SH "BUGS"
238 .IX Header "BUGS"
239 \&\fB\f(BIdup_func()\fB\fR is currently never called.
240 .PP
241 The return value of \fB\f(BInew_func()\fB\fR is ignored.
242 .PP
243 The \fB\f(BInew_func()\fB\fR function isn't very useful because no meaningful values are
244 present in the parent \s-1RSA\s0 structure when it is called.
245 .SH "SEE ALSO"
246 .IX Header "SEE ALSO"
247 \&\fIrsa\fR\|(3), \fICRYPTO_set_ex_data\fR\|(3)
248 .SH "HISTORY"
249 .IX Header "HISTORY"
250 \&\fIRSA_get_ex_new_index()\fR, \fIRSA_set_ex_data()\fR and \fIRSA_get_ex_data()\fR are
251 available since SSLeay 0.9.0.