secure/lib/libcrypto/man/RSA_get_ex_new_index.3

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