Merge from vendor branch HOSTAPD:
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_cert_verify_callback.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
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 "SSL_CTX_set_cert_verify_callback 3"
132 .TH SSL_CTX_set_cert_verify_callback 3 "2007-03-28" "0.9.8e" "OpenSSL"
133 .SH "NAME"
134 SSL_CTX_set_cert_verify_callback \- set peer certificate verification procedure
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 1
138 \& #include <openssl/ssl.h>
139 .Ve
140 .PP
141 .Vb 1
142 \& void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *,void *), void *arg);
143 .Ve
144 .SH "DESCRIPTION"
145 .IX Header "DESCRIPTION"
146 \&\fISSL_CTX_set_cert_verify_callback()\fR sets the verification callback function for
147 \&\fIctx\fR. \s-1SSL\s0 objects that are created from \fIctx\fR inherit the setting valid at
148 the time when \fISSL_new\fR\|(3) is called.
149 .SH "NOTES"
150 .IX Header "NOTES"
151 Whenever a certificate is verified during a \s-1SSL/TLS\s0 handshake, a verification
152 function is called. If the application does not explicitly specify a
153 verification callback function, the built-in verification function is used.
154 If a verification callback \fIcallback\fR is specified via
155 \&\fISSL_CTX_set_cert_verify_callback()\fR, the supplied callback function is called
156 instead. By setting \fIcallback\fR to \s-1NULL\s0, the default behaviour is restored.
157 .PP
158 When the verification must be performed, \fIcallback\fR will be called with
159 the arguments callback(X509_STORE_CTX *x509_store_ctx, void *arg). The 
160 argument \fIarg\fR is specified by the application when setting \fIcallback\fR.
161 .PP
162 \&\fIcallback\fR should return 1 to indicate verification success and 0 to
163 indicate verification failure. If \s-1SSL_VERIFY_PEER\s0 is set and \fIcallback\fR
164 returns 0, the handshake will fail. As the verification procedure may
165 allow to continue the connection in case of failure (by always returning 1)
166 the verification result must be set in any case using the \fBerror\fR
167 member of \fIx509_store_ctx\fR so that the calling application will be informed
168 about the detailed result of the verification procedure! 
169 .PP
170 Within \fIx509_store_ctx\fR, \fIcallback\fR has access to the \fIverify_callback\fR
171 function set using \fISSL_CTX_set_verify\fR\|(3).
172 .SH "WARNINGS"
173 .IX Header "WARNINGS"
174 Do not mix the verification callback described in this function with the
175 \&\fBverify_callback\fR function called during the verification process. The
176 latter is set using the \fISSL_CTX_set_verify\fR\|(3)
177 family of functions.
178 .PP
179 Providing a complete verification procedure including certificate purpose
180 settings etc is a complex task. The built-in procedure is quite powerful
181 and in most cases it should be sufficient to modify its behaviour using
182 the \fBverify_callback\fR function.
183 .SH "BUGS"
184 .IX Header "BUGS"
185 .SH "RETURN VALUES"
186 .IX Header "RETURN VALUES"
187 \&\fISSL_CTX_set_cert_verify_callback()\fR does not provide diagnostic information.
188 .SH "SEE ALSO"
189 .IX Header "SEE ALSO"
190 \&\fIssl\fR\|(3), \fISSL_CTX_set_verify\fR\|(3),
191 \&\fISSL_get_verify_result\fR\|(3),
192 \&\fISSL_CTX_load_verify_locations\fR\|(3)
193 .SH "HISTORY"
194 .IX Header "HISTORY"
195 Previous to OpenSSL 0.9.7, the \fIarg\fR argument to \fBSSL_CTX_set_cert_verify_callback\fR
196 was ignored, and \fIcallback\fR was called simply as
197  int (*callback)(X509_STORE_CTX *)
198 To compile software written for previous versions of OpenSSL, a dummy
199 argument will have to be added to \fIcallback\fR.