lib/libssl/man/SSL_get_peer_cert_chain.3

   1 .\"     $OpenBSD: SSL_get_peer_cert_chain.3,v 1.3 2017/03/28 18:21:55 schwarze Exp $
   2 .\"     OpenSSL SSL_get_peer_cert_chain.pod 1f164c6f Jan 18 01:40:36 2017 +0100
   3 .\"     OpenSSL SSL_get_peer_cert_chain.pod 9b86974e Aug 17 15:21:33 2015 -0400
   4 .\"
   5 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   6 .\" Copyright (c) 2000, 2005, 2014, 2016 The OpenSSL Project.
   7 .\" All rights reserved.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\"
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\"
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in
  18 .\"    the documentation and/or other materials provided with the
  19 .\"    distribution.
  20 .\"
  21 .\" 3. All advertising materials mentioning features or use of this
  22 .\"    software must display the following acknowledgment:
  23 .\"    "This product includes software developed by the OpenSSL Project
  24 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  25 .\"
  26 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27 .\"    endorse or promote products derived from this software without
  28 .\"    prior written permission. For written permission, please contact
  29 .\"    openssl-core@openssl.org.
  30 .\"
  31 .\" 5. Products derived from this software may not be called "OpenSSL"
  32 .\"    nor may "OpenSSL" appear in their names without prior written
  33 .\"    permission of the OpenSSL Project.
  34 .\"
  35 .\" 6. Redistributions of any form whatsoever must retain the following
  36 .\"    acknowledgment:
  37 .\"    "This product includes software developed by the OpenSSL Project
  38 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  52 .\"
  53 .Dd $Mdocdate: March 28 2017 $
  54 .Dt SSL_GET_PEER_CERT_CHAIN 3
  55 .Os
  56 .Sh NAME
  57 .Nm SSL_get_peer_cert_chain
  58 .Nd get the X509 certificate chain sent by the peer
  59 .Sh SYNOPSIS
  60 .In openssl/ssl.h
  61 .Ft STACK_OF(X509) *
  62 .Fn SSL_get_peer_cert_chain "const SSL *ssl"
  63 .Sh DESCRIPTION
  64 .Fn SSL_get_peer_cert_chain
  65 returns a pointer to
  66 .Dv STACK_OF Ns Po Vt X509 Pc
  67 certificates forming the certificate chain of the peer.
  68 If called on the client side, the stack also contains the peer's certificate;
  69 if called on the server side, the peer's certificate must be obtained
  70 separately using
  71 .Xr SSL_get_peer_certificate 3 .
  72 If the peer did not present a certificate,
  73 .Dv NULL
  74 is returned.
  75 .Pp
  76 .Fn SSL_get_peer_cert_chain
  77 returns the peer chain as sent by the peer: it only consists of
  78 certificates the peer has sent (in the order the peer has sent them)
  79 and it is not a verified chain.
  80 .Pp
  81 If the session is resumed, peers do not send certificates, so a
  82 .Dv NULL
  83 pointer is returned.
  84 Applications can call
  85 .Fn SSL_session_reused
  86 to determine whether a session is resumed.
  87 .Pp
  88 The reference count of the
  89 .Dv STACK_OF Ns Po Vt X509 Pc
  90 object is not incremented.
  91 If the corresponding session is freed, the pointer must not be used any longer.
  92 .Sh RETURN VALUES
  93 The following return values can occur:
  94 .Bl -tag -width Ds
  95 .It Dv NULL
  96 No certificate was presented by the peer or no connection was established or
  97 the certificate chain is no longer available when a session is reused.
  98 .It Pointer to a Dv STACK_OF Ns Po X509 Pc
  99 The return value points to the certificate chain presented by the peer.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr ssl 3 ,
 103 .Xr SSL_get_peer_certificate 3