Update files for OpenSSL-1.0.1b import.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_cert_verify_callback.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SSL_CTX_set_cert_verify_callback 3"
127 .TH SSL_CTX_set_cert_verify_callback 3 "2012-04-26" "1.0.1b" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 SSL_CTX_set_cert_verify_callback \- set peer certificate verification procedure
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/ssl.h>
138 \&
139 \& void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *,void *), void *arg);
140 .Ve
141 .SH "DESCRIPTION"
142 .IX Header "DESCRIPTION"
143 \&\fISSL_CTX_set_cert_verify_callback()\fR sets the verification callback function for
144 \&\fIctx\fR. \s-1SSL\s0 objects that are created from \fIctx\fR inherit the setting valid at
145 the time when \fISSL_new\fR\|(3) is called.
146 .SH "NOTES"
147 .IX Header "NOTES"
148 Whenever a certificate is verified during a \s-1SSL/TLS\s0 handshake, a verification
149 function is called. If the application does not explicitly specify a
150 verification callback function, the built-in verification function is used.
151 If a verification callback \fIcallback\fR is specified via
152 \&\fISSL_CTX_set_cert_verify_callback()\fR, the supplied callback function is called
153 instead. By setting \fIcallback\fR to \s-1NULL\s0, the default behaviour is restored.
154 .PP
155 When the verification must be performed, \fIcallback\fR will be called with
156 the arguments callback(X509_STORE_CTX *x509_store_ctx, void *arg). The 
157 argument \fIarg\fR is specified by the application when setting \fIcallback\fR.
158 .PP
159 \&\fIcallback\fR should return 1 to indicate verification success and 0 to
160 indicate verification failure. If \s-1SSL_VERIFY_PEER\s0 is set and \fIcallback\fR
161 returns 0, the handshake will fail. As the verification procedure may
162 allow to continue the connection in case of failure (by always returning 1)
163 the verification result must be set in any case using the \fBerror\fR
164 member of \fIx509_store_ctx\fR so that the calling application will be informed
165 about the detailed result of the verification procedure!
166 .PP
167 Within \fIx509_store_ctx\fR, \fIcallback\fR has access to the \fIverify_callback\fR
168 function set using \fISSL_CTX_set_verify\fR\|(3).
169 .SH "WARNINGS"
170 .IX Header "WARNINGS"
171 Do not mix the verification callback described in this function with the
172 \&\fBverify_callback\fR function called during the verification process. The
173 latter is set using the \fISSL_CTX_set_verify\fR\|(3)
174 family of functions.
175 .PP
176 Providing a complete verification procedure including certificate purpose
177 settings etc is a complex task. The built-in procedure is quite powerful
178 and in most cases it should be sufficient to modify its behaviour using
179 the \fBverify_callback\fR function.
180 .SH "BUGS"
181 .IX Header "BUGS"
182 .SH "RETURN VALUES"
183 .IX Header "RETURN VALUES"
184 \&\fISSL_CTX_set_cert_verify_callback()\fR does not provide diagnostic information.
185 .SH "SEE ALSO"
186 .IX Header "SEE ALSO"
187 \&\fIssl\fR\|(3), \fISSL_CTX_set_verify\fR\|(3),
188 \&\fISSL_get_verify_result\fR\|(3),
189 \&\fISSL_CTX_load_verify_locations\fR\|(3)
190 .SH "HISTORY"
191 .IX Header "HISTORY"
192 Previous to OpenSSL 0.9.7, the \fIarg\fR argument to \fBSSL_CTX_set_cert_verify_callback\fR
193 was ignored, and \fIcallback\fR was called simply as
194  int (*callback)(X509_STORE_CTX *)
195 To compile software written for previous versions of OpenSSL, a dummy
196 argument will have to be added to \fIcallback\fR.