lib/libssl/man/SSL_CTX_add_extra_chain_cert.3

   1 .\"     $OpenBSD: SSL_CTX_add_extra_chain_cert.3,v 1.2 2016/11/30 12:55:25 schwarze Exp $
   2 .\"     OpenSSL f0d6ee6be Feb 15 07:41:42 2002 +0000
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org> and
   5 .\" Dr. Stephen Henson <steve@openssl.org>.
   6 .\" Copyright (c) 2000, 2002, 2013, 2015 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: November 30 2016 $
  54 .Dt SSL_CTX_ADD_EXTRA_CHAIN_CERT 3
  55 .Os
  56 .Sh NAME
  57 .Nm SSL_CTX_add_extra_chain_cert ,
  58 .Nm SSL_CTX_clear_extra_chain_certs
  59 .Nd add or clear extra chain certificates
  60 .Sh SYNOPSIS
  61 .In openssl/ssl.h
  62 .Ft long
  63 .Fn SSL_CTX_add_extra_chain_cert "SSL_CTX *ctx" "X509 *x509"
  64 .Ft long
  65 .Fn SSL_CTX_clear_extra_chain_certs "SSL_CTX *ctx"
  66 .Sh DESCRIPTION
  67 .Fn SSL_CTX_add_extra_chain_cert
  68 adds the certificate
  69 .Fa x509
  70 to the extra chain certificates associated with
  71 .Fa ctx .
  72 Several certificates can be added one after another.
  73 .Pp
  74 .Fn SSL_CTX_clear_extra_chain_certs
  75 clears all extra chain certificates associated with
  76 .Fa ctx .
  77 .Pp
  78 These functions are implemented as macros.
  79 .Pp
  80 When sending a certificate chain, extra chain certificates are sent
  81 in order following the end entity certificate.
  82 .Pp
  83 If no chain is specified, the library will try to complete the chain from the
  84 available CA certificates in the trusted CA storage, see
  85 .Xr SSL_CTX_load_verify_locations 3 .
  86 .Pp
  87 The x509 certificate provided to
  88 .Fn SSL_CTX_add_extra_chain_cert
  89 will be freed by the library when the
  90 .Vt SSL_CTX
  91 is destroyed.
  92 An application should not free the
  93 .Fa x509
  94 object.
  95 .Sh RETURN VALUES
  96 .Fn SSL_CTX_add_extra_chain_cert
  97 and
  98 .Fn SSL_CTX_clear_extra_chain_certs
  99 return 1 on success or 0 for failure.
 100 Check out the error stack to find out the reason for failure.
 101 .Sh SEE ALSO
 102 .Xr ssl 3 ,
 103 .Xr SSL_CTX_load_verify_locations 3 ,
 104 .Xr SSL_CTX_set_client_cert_cb 3 ,
 105 .Xr SSL_CTX_use_certificate 3
 106 .Sh CAVEATS
 107 Only one set of extra chain certificates can be specified per
 108 .Vt SSL_CTX
 109 structure.
 110 Different chains for different certificates (for example if both
 111 RSA and DSA certificates are specified by the same server) or
 112 different SSL structures with the same parent
 113 .Vt SSL_CTX
 114 cannot be specified using this function.