323 lines
9.7 KiB
Groff
323 lines
9.7 KiB
Groff
|
.rn '' }`
|
||
|
|
'''
|
||
|
|
'''
|
||
|
|
.de Sh
|
||
|
|
.br
|
||
|
|
.if t .Sp
|
||
|
|
.ne 5
|
||
|
|
.PP
|
||
|
|
\fB\\$1\fR
|
||
|
|
.PP
|
||
|
|
..
|
||
|
|
.de Sp
|
||
|
|
.if t .sp .5v
|
||
|
|
.if n .sp
|
||
|
|
..
|
||
|
|
.de Ip
|
||
|
|
.br
|
||
|
|
.ie \\n(.$>=3 .ne \\$3
|
||
|
|
.el .ne 3
|
||
|
|
.IP "\\$1" \\$2
|
||
|
|
..
|
||
|
|
.de Vb
|
||
|
|
.ft CW
|
||
|
|
.nf
|
||
|
|
.ne \\$1
|
||
|
|
..
|
||
|
|
.de Ve
|
||
|
|
.ft R
|
||
|
|
|
||
|
|
.fi
|
||
|
|
..
|
||
|
|
'''
|
||
|
|
'''
|
||
|
|
''' Set up \*(-- to give an unbreakable dash;
|
||
|
|
''' string Tr holds user defined translation string.
|
||
|
|
''' Bell System Logo is used as a dummy character.
|
||
|
|
'''
|
||
|
|
.tr \(*W-|\(bv\*(Tr
|
||
|
|
.ie n \{\
|
||
|
|
.ds -- \(*W-
|
||
|
|
.ds PI pi
|
||
|
|
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
||
|
|
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||
|
|
.ds L" ""
|
||
|
|
.ds R" ""
|
||
|
|
''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
|
||
|
|
''' \*(L" and \*(R", except that they are used on ".xx" lines,
|
||
|
|
''' such as .IP and .SH, which do another additional levels of
|
||
|
|
''' double-quote interpretation
|
||
|
|
.ds M" """
|
||
|
|
.ds S" """
|
||
|
|
.ds N" """""
|
||
|
|
.ds T" """""
|
||
|
|
.ds L' '
|
||
|
|
.ds R' '
|
||
|
|
.ds M' '
|
||
|
|
.ds S' '
|
||
|
|
.ds N' '
|
||
|
|
.ds T' '
|
||
|
|
'br\}
|
||
|
|
.el\{\
|
||
|
|
.ds -- \(em\|
|
||
|
|
.tr \*(Tr
|
||
|
|
.ds L" ``
|
||
|
|
.ds R" ''
|
||
|
|
.ds M" ``
|
||
|
|
.ds S" ''
|
||
|
|
.ds N" ``
|
||
|
|
.ds T" ''
|
||
|
|
.ds L' `
|
||
|
|
.ds R' '
|
||
|
|
.ds M' `
|
||
|
|
.ds S' '
|
||
|
|
.ds N' `
|
||
|
|
.ds T' '
|
||
|
|
.ds PI \(*p
|
||
|
|
'br\}
|
||
|
|
.\" If the F register is turned on, we'll generate
|
||
|
|
.\" index entries out stderr for the following things:
|
||
|
|
.\" TH Title
|
||
|
|
.\" SH Header
|
||
|
|
.\" Sh Subsection
|
||
|
|
.\" Ip Item
|
||
|
|
.\" X<> Xref (embedded
|
||
|
|
.\" Of course, you have to process the output yourself
|
||
|
|
.\" in some meaninful fashion.
|
||
|
|
.if \nF \{
|
||
|
|
.de IX
|
||
|
|
.tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
.nr % 0
|
||
|
|
.rr F
|
||
|
|
.\}
|
||
|
|
.TH RSA_get_ex_new_index 3 "0.9.5a" "22/Jul/100" "OpenSSL"
|
||
|
|
.UC
|
||
|
|
.if n .hy 0
|
||
|
|
.if n .na
|
||
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||
|
|
.de CQ \" put $1 in typewriter font
|
||
|
|
.ft CW
|
||
|
|
'if n "\c
|
||
|
|
'if t \\&\\$1\c
|
||
|
|
'if n \\&\\$1\c
|
||
|
|
'if n \&"
|
||
|
|
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
|
||
|
|
'.ft R
|
||
|
|
..
|
||
|
|
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
|
||
|
|
. \" AM - accent mark definitions
|
||
|
|
.bd B 3
|
||
|
|
. \" fudge factors for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds #H 0
|
||
|
|
. ds #V .8m
|
||
|
|
. ds #F .3m
|
||
|
|
. ds #[ \f1
|
||
|
|
. ds #] \fP
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
|
. ds #V .6m
|
||
|
|
. ds #F 0
|
||
|
|
. ds #[ \&
|
||
|
|
. ds #] \&
|
||
|
|
.\}
|
||
|
|
. \" simple accents for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds ' \&
|
||
|
|
. ds ` \&
|
||
|
|
. ds ^ \&
|
||
|
|
. ds , \&
|
||
|
|
. ds ~ ~
|
||
|
|
. ds ? ?
|
||
|
|
. ds ! !
|
||
|
|
. ds /
|
||
|
|
. ds q
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||
|
|
. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
|
||
|
|
. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
|
||
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||
|
|
. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
|
||
|
|
.\}
|
||
|
|
. \" troff and (daisy-wheel) nroff accents
|
||
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
|
.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
|
||
|
|
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
|
||
|
|
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
|
||
|
|
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
|
||
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
|
.ds oe o\h'-(\w'o'u*4/10)'e
|
||
|
|
.ds Oe O\h'-(\w'O'u*4/10)'E
|
||
|
|
. \" corrections for vroff
|
||
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
|
. \" for low resolution devices (crt and lpr)
|
||
|
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
|
\{\
|
||
|
|
. ds : e
|
||
|
|
. ds 8 ss
|
||
|
|
. ds v \h'-1'\o'\(aa\(ga'
|
||
|
|
. ds _ \h'-1'^
|
||
|
|
. ds . \h'-1'.
|
||
|
|
. ds 3 3
|
||
|
|
. ds o a
|
||
|
|
. ds d- d\h'-1'\(ga
|
||
|
|
. ds D- D\h'-1'\(hy
|
||
|
|
. ds th \o'bp'
|
||
|
|
. ds Th \o'LP'
|
||
|
|
. ds ae ae
|
||
|
|
. ds Ae AE
|
||
|
|
. ds oe oe
|
||
|
|
. ds Oe OE
|
||
|
|
.\}
|
||
|
|
.rm #[ #] #H #V #F C
|
||
|
|
.SH "NAME"
|
||
|
|
RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data \- add application specific data to RSA structures
|
||
|
|
.SH "LIBRARY"
|
||
|
|
libcrypto, -lcrypto
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& #include <openssl/rsa.h>
|
||
|
|
.Ve
|
||
|
|
.Vb 4
|
||
|
|
\& int RSA_get_ex_new_index(long argl, void *argp,
|
||
|
|
\& CRYPTO_EX_new *new_func,
|
||
|
|
\& CRYPTO_EX_dup *dup_func,
|
||
|
|
\& CRYPTO_EX_free *free_func);
|
||
|
|
.Ve
|
||
|
|
.Vb 1
|
||
|
|
\& int RSA_set_ex_data(RSA *r, int idx, void *arg);
|
||
|
|
.Ve
|
||
|
|
.Vb 1
|
||
|
|
\& void *RSA_get_ex_data(RSA *r, int idx);
|
||
|
|
.Ve
|
||
|
|
.Vb 2
|
||
|
|
\& int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
|
||
|
|
\& int idx, long argl, void *argp);
|
||
|
|
.Ve
|
||
|
|
.Vb 2
|
||
|
|
\& void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
|
||
|
|
\& int idx, long argl, void *argp);
|
||
|
|
.Ve
|
||
|
|
.Vb 2
|
||
|
|
\& int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
|
||
|
|
\& int idx, long argl, void *argp);
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
Several OpenSSL structures can have application specific data attached to them.
|
||
|
|
This has several potential uses, it can be used to cache data associated with
|
||
|
|
a structure (for example the hash of some part of the structure) or some
|
||
|
|
additional data (for example a handle to the data in an external library).
|
||
|
|
.PP
|
||
|
|
Since the application data can be anything at all it is passed and retrieved
|
||
|
|
as a \fBvoid *\fR type.
|
||
|
|
.PP
|
||
|
|
The \fBRSA_get_ex_new_index()\fR function is initially called to \*(L"register\*(R" some
|
||
|
|
new application specific data. It takes three optional function pointers which
|
||
|
|
are called when the parent structure (in this case an RSA structure) is
|
||
|
|
initially created, when it is copied and when it is freed up. If any or all of
|
||
|
|
these function pointer arguments are not used they should be set to NULL. The
|
||
|
|
precise manner in which these function pointers are called is described in more
|
||
|
|
detail below. \fBRSA_get_ex_new_index()\fR also takes additional long and pointer
|
||
|
|
parameters which will be passed to the supplied functions but which otherwise
|
||
|
|
have no special meaning. It returns an \fBindex\fR which should be stored
|
||
|
|
(typically in a static variable) and passed used in the \fBidx\fR parameter in
|
||
|
|
the remaining functions. Each successful call to \fBRSA_get_ex_new_index()\fR
|
||
|
|
will return an index greater than any previously returned, this is important
|
||
|
|
because the optional functions are called in order of increasing index value.
|
||
|
|
.PP
|
||
|
|
\fBRSA_set_ex_data()\fR is used to set application specific data, the data is
|
||
|
|
supplied in the \fBarg\fR parameter and its precise meaning is up to the
|
||
|
|
application.
|
||
|
|
.PP
|
||
|
|
\fBRSA_get_ex_data()\fR is used to retrieve application specific data. The data
|
||
|
|
is returned to the application, this will be the same value as supplied to
|
||
|
|
a previous \fBRSA_set_ex_data()\fR call.
|
||
|
|
.PP
|
||
|
|
\fBnew_func()\fR is called when a structure is initially allocated (for example
|
||
|
|
with \fBRSA_new()\fR. The parent structure members will not have any meaningful
|
||
|
|
values at this point. This function will typically be used to allocate any
|
||
|
|
application specific structure.
|
||
|
|
.PP
|
||
|
|
\fBfree_func()\fR is called when a structure is being freed up. The dynamic parent
|
||
|
|
structure members should not be accessed because they will be freed up when
|
||
|
|
this function is called.
|
||
|
|
.PP
|
||
|
|
\fBnew_func()\fR and \fBfree_func()\fR take the same parameters. \fBparent\fR is a
|
||
|
|
pointer to the parent RSA structure. \fBptr\fR is a the application specific data
|
||
|
|
(this wont be of much use in \fBnew_func()\fR. \fBad\fR is a pointer to the
|
||
|
|
\fBCRYPTO_EX_DATA\fR structure from the parent RSA structure: the functions
|
||
|
|
\fBCRYPTO_get_ex_data()\fR and \fBCRYPTO_set_ex_data()\fR can be called to manipulate
|
||
|
|
it. The \fBidx\fR parameter is the index: this will be the same value returned by
|
||
|
|
\fBRSA_get_ex_new_index()\fR when the functions were initially registered. Finally
|
||
|
|
the \fBargl\fR and \fBargp\fR parameters are the values originally passed to the same
|
||
|
|
corresponding parameters when \fBRSA_get_ex_new_index()\fR was called.
|
||
|
|
.PP
|
||
|
|
\fBdup_func()\fR is called when a structure is being copied. Pointers to the
|
||
|
|
destination and source \fBCRYPTO_EX_DATA\fR structures are passed in the \fBto\fR and
|
||
|
|
\fBfrom\fR parameters respectively. The \fBfrom_d\fR parameter is passed a pointer to
|
||
|
|
the source application data when the function is called, when the function returns
|
||
|
|
the value is copied to the destination: the application can thus modify the data
|
||
|
|
pointed to by \fBfrom_d\fR and have different values in the source and destination.
|
||
|
|
The \fBidx\fR, \fBargl\fR and \fBargp\fR parameters are the same as those in \fBnew_func()\fR
|
||
|
|
and \fBfree_func()\fR.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
\fBRSA_get_ex_new_index()\fR returns a new index or \-1 on failure (note 0 is a valid
|
||
|
|
index value).
|
||
|
|
.PP
|
||
|
|
\fBRSA_set_ex_data()\fR returns 1 on success or 0 on failure.
|
||
|
|
.PP
|
||
|
|
\fBRSA_get_ex_data()\fR returns the application data or 0 on failure. 0 may also
|
||
|
|
be valid application data but currently it can only fail if given an invalid \fBidx\fR
|
||
|
|
parameter.
|
||
|
|
.PP
|
||
|
|
\fBnew_func()\fR and \fBdup_func()\fR should return 0 for failure and 1 for success.
|
||
|
|
.PP
|
||
|
|
On failure an error code can be obtained from the \fIERR_get_error(3)|ERR_get_error(3)\fR manpage.
|
||
|
|
.SH "BUGS"
|
||
|
|
\fBdup_func()\fR is currently never called.
|
||
|
|
.PP
|
||
|
|
The return value of \fBnew_func()\fR is ignored.
|
||
|
|
.PP
|
||
|
|
The \fBnew_func()\fR function isn't very useful because no meaningful values are
|
||
|
|
present in the parent RSA structure when it is called.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
the \fIrsa(3)|rsa(3)\fR manpage, the \fICRYPTO_set_ex_data(3)|CRYPTO_set_ex_data(3)\fR manpage
|
||
|
|
.SH "HISTORY"
|
||
|
|
\fIRSA_get_ex_new_index()\fR, \fIRSA_set_ex_data()\fR and \fIRSA_get_ex_data()\fR are
|
||
|
|
available since SSLeay 0.9.0.
|
||
|
|
|
||
|
|
.rn }` ''
|
||
|
|
.IX Title "RSA_get_ex_new_index 3"
|
||
|
|
.IX Name "RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specific data to RSA structures"
|
||
|
|
|
||
|
|
.IX Header "NAME"
|
||
|
|
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
|
||
|
|
.IX Header "RETURN VALUES"
|
||
|
|
|
||
|
|
.IX Header "BUGS"
|
||
|
|
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
|