diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_get_peer_certificate.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_peer_certificate.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_get_peer_certificate.3 | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/src/lib/libssl/doc/SSL_get_peer_certificate.3 b/src/lib/libssl/doc/SSL_get_peer_certificate.3 deleted file mode 100644 index bb32572356..0000000000 --- a/src/lib/libssl/doc/SSL_get_peer_certificate.3 +++ /dev/null | |||
@@ -1,53 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_get_peer_certificate.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_GET_PEER_CERTIFICATE 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_get_peer_certificate | ||
9 | .Nd get the X509 certificate of the peer | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft X509 * | ||
13 | .Fn SSL_get_peer_certificate "const SSL *ssl" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_get_peer_certificate | ||
16 | returns a pointer to the X509 certificate the peer presented. | ||
17 | If the peer did not present a certificate, | ||
18 | .Dv NULL | ||
19 | is returned. | ||
20 | .Sh NOTES | ||
21 | Due to the protocol definition, a TLS/SSL server will always send a | ||
22 | certificate, if present. | ||
23 | A client will only send a certificate when explicitly requested to do so by the | ||
24 | server (see | ||
25 | .Xr SSL_CTX_set_verify 3 ) . | ||
26 | If an anonymous cipher is used, no certificates are sent. | ||
27 | .Pp | ||
28 | That a certificate is returned does not indicate information about the | ||
29 | verification state. | ||
30 | Use | ||
31 | .Xr SSL_get_verify_result 3 | ||
32 | to check the verification state. | ||
33 | .Pp | ||
34 | The reference count of the | ||
35 | .Vt X509 | ||
36 | object is incremented by one, so that it will not be destroyed when the session | ||
37 | containing the peer certificate is freed. | ||
38 | The | ||
39 | .Vt X509 | ||
40 | object must be explicitly freed using | ||
41 | .Xr X509_free 3 . | ||
42 | .Sh RETURN VALUES | ||
43 | The following return values can occur: | ||
44 | .Bl -tag -width Ds | ||
45 | .It Dv NULL | ||
46 | No certificate was presented by the peer or no connection was established. | ||
47 | .It Pointer to an X509 certificate | ||
48 | The return value points to the certificate presented by the peer. | ||
49 | .El | ||
50 | .Sh SEE ALSO | ||
51 | .Xr ssl 3 , | ||
52 | .Xr SSL_CTX_set_verify 3 , | ||
53 | .Xr SSL_get_verify_result 3 | ||