230 lines
7.8 KiB
Groff
230 lines
7.8 KiB
Groff
.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.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" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is >0, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.if !\nF .nr F 0
|
|
.if \nF>0 \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" 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 /
|
|
.\}
|
|
.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 / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" 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 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
|
|
. \" 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 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "BIO_set_callback 3"
|
|
.TH BIO_set_callback 3 "2017-05-25" "1.0.2l" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
BIO_set_callback, BIO_get_callback, BIO_set_callback_arg, BIO_get_callback_arg,
|
|
BIO_debug_callback \- BIO callback functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/bio.h>
|
|
\&
|
|
\& #define BIO_set_callback(b,cb) ((b)\->callback=(cb))
|
|
\& #define BIO_get_callback(b) ((b)\->callback)
|
|
\& #define BIO_set_callback_arg(b,arg) ((b)\->cb_arg=(char *)(arg))
|
|
\& #define BIO_get_callback_arg(b) ((b)\->cb_arg)
|
|
\&
|
|
\& long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
|
|
\& long argl,long ret);
|
|
\&
|
|
\& typedef long (*callback)(BIO *b, int oper, const char *argp,
|
|
\& int argi, long argl, long retvalue);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fIBIO_set_callback()\fR and \fIBIO_get_callback()\fR set and retrieve the \s-1BIO\s0 callback,
|
|
they are both macros. The callback is called during most high level \s-1BIO\s0
|
|
operations. It can be used for debugging purposes to trace operations on
|
|
a \s-1BIO\s0 or to modify its operation.
|
|
.PP
|
|
\&\fIBIO_set_callback_arg()\fR and \fIBIO_get_callback_arg()\fR are macros which can be
|
|
used to set and retrieve an argument for use in the callback.
|
|
.PP
|
|
\&\fIBIO_debug_callback()\fR is a standard debugging callback which prints
|
|
out information relating to each \s-1BIO\s0 operation. If the callback
|
|
argument is set if is interpreted as a \s-1BIO\s0 to send the information
|
|
to, otherwise stderr is used.
|
|
.PP
|
|
\&\fIcallback()\fR is the callback function itself. The meaning of each
|
|
argument is described below.
|
|
.PP
|
|
The \s-1BIO\s0 the callback is attached to is passed in \fBb\fR.
|
|
.PP
|
|
\&\fBoper\fR is set to the operation being performed. For some operations
|
|
the callback is called twice, once before and once after the actual
|
|
operation, the latter case has \fBoper\fR or'ed with \s-1BIO_CB_RETURN.\s0
|
|
.PP
|
|
The meaning of the arguments \fBargp\fR, \fBargi\fR and \fBargl\fR depends on
|
|
the value of \fBoper\fR, that is the operation being performed.
|
|
.PP
|
|
\&\fBretvalue\fR is the return value that would be returned to the
|
|
application if no callback were present. The actual value returned
|
|
is the return value of the callback itself. In the case of callbacks
|
|
called before the actual \s-1BIO\s0 operation 1 is placed in retvalue, if
|
|
the return value is not positive it will be immediately returned to
|
|
the application and the \s-1BIO\s0 operation will not be performed.
|
|
.PP
|
|
The callback should normally simply return \fBretvalue\fR when it has
|
|
finished processing, unless if specifically wishes to modify the
|
|
value returned to the application.
|
|
.SH "CALLBACK OPERATIONS"
|
|
.IX Header "CALLBACK OPERATIONS"
|
|
.IP "\fBBIO_free(b)\fR" 4
|
|
.IX Item "BIO_free(b)"
|
|
callback(b, \s-1BIO_CB_FREE, NULL, 0L, 0L, 1L\s0) is called before the
|
|
free operation.
|
|
.IP "\fBBIO_read(b, out, outl)\fR" 4
|
|
.IX Item "BIO_read(b, out, outl)"
|
|
callback(b, \s-1BIO_CB_READ,\s0 out, outl, 0L, 1L) is called before
|
|
the read and callback(b, BIO_CB_READ|BIO_CB_RETURN, out, outl, 0L, retvalue)
|
|
after.
|
|
.IP "\fBBIO_write(b, in, inl)\fR" 4
|
|
.IX Item "BIO_write(b, in, inl)"
|
|
callback(b, \s-1BIO_CB_WRITE,\s0 in, inl, 0L, 1L) is called before
|
|
the write and callback(b, BIO_CB_WRITE|BIO_CB_RETURN, in, inl, 0L, retvalue)
|
|
after.
|
|
.IP "\fBBIO_gets(b, out, outl)\fR" 4
|
|
.IX Item "BIO_gets(b, out, outl)"
|
|
callback(b, \s-1BIO_CB_GETS,\s0 out, outl, 0L, 1L) is called before
|
|
the operation and callback(b, BIO_CB_GETS|BIO_CB_RETURN, out, outl, 0L, retvalue)
|
|
after.
|
|
.IP "\fBBIO_puts(b, in)\fR" 4
|
|
.IX Item "BIO_puts(b, in)"
|
|
callback(b, \s-1BIO_CB_WRITE,\s0 in, 0, 0L, 1L) is called before
|
|
the operation and callback(b, BIO_CB_WRITE|BIO_CB_RETURN, in, 0, 0L, retvalue)
|
|
after.
|
|
.IP "\fBBIO_ctrl(\s-1BIO\s0 *b, int cmd, long larg, void *parg)\fR" 4
|
|
.IX Item "BIO_ctrl(BIO *b, int cmd, long larg, void *parg)"
|
|
callback(b,BIO_CB_CTRL,parg,cmd,larg,1L) is called before the call and
|
|
callback(b,BIO_CB_CTRL|BIO_CB_RETURN,parg,cmd, larg,ret) after.
|
|
.SH "EXAMPLE"
|
|
.IX Header "EXAMPLE"
|
|
The \fIBIO_debug_callback()\fR function is a good example, its source is
|
|
in crypto/bio/bio_cb.c
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\s-1TBA\s0
|