secure/lib/libcrypto/man/RSA_get_ex_new_index.3

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