preprocessor cleanup: __lint
[unleashed/tickless.git] / lib / libssl / man / SSL_get_verify_result.3
blob78bf636a481903f4d016b163021e323cf0839ecd
1 .\"     $OpenBSD: SSL_get_verify_result.3,v 1.2 2016/12/03 08:54:21 schwarze Exp $
2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3 .\"
4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5 .\" Copyright (c) 2000, 2001, 2005 The OpenSSL Project.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\"
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in
16 .\"    the documentation and/or other materials provided with the
17 .\"    distribution.
18 .\"
19 .\" 3. All advertising materials mentioning features or use of this
20 .\"    software must display the following acknowledgment:
21 .\"    "This product includes software developed by the OpenSSL Project
22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23 .\"
24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 .\"    endorse or promote products derived from this software without
26 .\"    prior written permission. For written permission, please contact
27 .\"    openssl-core@openssl.org.
28 .\"
29 .\" 5. Products derived from this software may not be called "OpenSSL"
30 .\"    nor may "OpenSSL" appear in their names without prior written
31 .\"    permission of the OpenSSL Project.
32 .\"
33 .\" 6. Redistributions of any form whatsoever must retain the following
34 .\"    acknowledgment:
35 .\"    "This product includes software developed by the OpenSSL Project
36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37 .\"
38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
50 .\"
51 .Dd $Mdocdate: December 3 2016 $
52 .Dt SSL_GET_VERIFY_RESULT 3
53 .Os
54 .Sh NAME
55 .Nm SSL_get_verify_result
56 .Nd get result of peer certificate verification
57 .Sh SYNOPSIS
58 .In openssl/ssl.h
59 .Ft long
60 .Fn SSL_get_verify_result "const SSL *ssl"
61 .Sh DESCRIPTION
62 .Fn SSL_get_verify_result
63 returns the result of the verification of the X509 certificate presented by the
64 peer, if any.
65 .Pp
66 .Fn SSL_get_verify_result
67 can only return one error code while the verification of a certificate can fail
68 because of many reasons at the same time.
69 Only the last verification error that occurred during the processing is
70 available from
71 .Fn SSL_get_verify_result .
72 .Pp
73 The verification result is part of the established session and is restored when
74 a session is reused.
75 .Sh RETURN VALUES
76 The following return values can currently occur:
77 .Bl -tag -width Ds
78 .It Dv X509_V_OK
79 The verification succeeded or no peer certificate was presented.
80 .It Any other value
81 Documented in
82 .Xr openssl 1 .
83 .El
84 .Sh SEE ALSO
85 .Xr openssl 1 ,
86 .Xr ssl 3 ,
87 .Xr SSL_get_peer_certificate 3 ,
88 .Xr SSL_set_verify_result 3
89 .Sh BUGS
90 If no peer certificate was presented, the returned result code is
91 .Dv X509_V_OK .
92 This is because no verification error occurred;
93 however, it does not indicate success.
94 .Fn SSL_get_verify_result
95 is only useful in connection with
96 .Xr SSL_get_peer_certificate 3 .