SSL_CTX_add1_chain_cert.pod 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. =pod
  2. =head1 NAME
  3. SSL_CTX_set0_chain, SSL_CTX_set1_chain, SSL_CTX_add0_chain_cert,
  4. SSL_CTX_add1_chain_cert, SSL_CTX_get0_chain_certs, SSL_CTX_clear_chain_certs,
  5. SSL_set0_chain, SSL_set1_chain, SSL_add0_chain_cert, SSL_add1_chain_cert,
  6. SSL_get0_chain_certs, SSL_clear_chain_certs, SSL_CTX_build_cert_chain,
  7. SSL_build_cert_chain, SSL_CTX_select_current_cert,
  8. SSL_select_current_cert, SSL_CTX_set_current_cert, SSL_set_current_cert - extra
  9. chain certificate processing
  10. =head1 SYNOPSIS
  11. #include <openssl/ssl.h>
  12. int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
  13. int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
  14. int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
  15. int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
  16. int SSL_CTX_get0_chain_certs(SSL_CTX *ctx, STACK_OF(X509) **sk);
  17. int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
  18. int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *sk);
  19. int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *sk);
  20. int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
  21. int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
  22. int SSL_get0_chain_certs(SSL *ssl, STACK_OF(X509) **sk);
  23. int SSL_clear_chain_certs(SSL *ssl);
  24. int SSL_CTX_build_cert_chain(SSL_CTX *ctx, flags);
  25. int SSL_build_cert_chain(SSL *ssl, flags);
  26. int SSL_CTX_select_current_cert(SSL_CTX *ctx, X509 *x509);
  27. int SSL_select_current_cert(SSL *ssl, X509 *x509);
  28. int SSL_CTX_set_current_cert(SSL_CTX *ctx, long op);
  29. int SSL_set_current_cert(SSL *ssl, long op);
  30. =head1 DESCRIPTION
  31. SSL_CTX_set0_chain() and SSL_CTX_set1_chain() set the certificate chain
  32. associated with the current certificate of B<ctx> to B<sk>.
  33. SSL_CTX_add0_chain_cert() and SSL_CTX_add1_chain_cert() append the single
  34. certificate B<x509> to the chain associated with the current certificate of
  35. B<ctx>.
  36. SSL_CTX_get0_chain_certs() retrieves the chain associated with the current
  37. certificate of B<ctx>.
  38. SSL_CTX_clear_chain_certs() clears any existing chain associated with the
  39. current certificate of B<ctx>. (This is implemented by calling
  40. SSL_CTX_set0_chain() with B<sk> set to B<NULL>).
  41. SSL_CTX_build_cert_chain() builds the certificate chain for B<ctx> normally
  42. this uses the chain store or the verify store if the chain store is not set.
  43. If the function is successful the built chain will replace any existing chain.
  44. The B<flags> parameter can be set to B<SSL_BUILD_CHAIN_FLAG_UNTRUSTED> to use
  45. existing chain certificates as untrusted CAs, B<SSL_BUILD_CHAIN_FLAG_NO_ROOT>
  46. to omit the root CA from the built chain, B<SSL_BUILD_CHAIN_FLAG_CHECK> to
  47. use all existing chain certificates only to build the chain (effectively
  48. sanity checking and rearranging them if necessary), the flag
  49. B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> ignores any errors during verification:
  50. if flag B<SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR> is also set verification errors
  51. are cleared from the error queue.
  52. Each of these functions operates on the I<current> end entity
  53. (i.e. server or client) certificate. This is the last certificate loaded or
  54. selected on the corresponding B<ctx> structure.
  55. SSL_CTX_select_current_cert() selects B<x509> as the current end entity
  56. certificate, but only if B<x509> has already been loaded into B<ctx> using a
  57. function such as SSL_CTX_use_certificate().
  58. SSL_set0_chain(), SSL_set1_chain(), SSL_add0_chain_cert(),
  59. SSL_add1_chain_cert(), SSL_get0_chain_certs(), SSL_clear_chain_certs(),
  60. SSL_build_cert_chain(), SSL_select_current_cert() and SSL_set_current_cert()
  61. are similar except they apply to SSL structure B<ssl>.
  62. SSL_CTX_set_current_cert() changes the current certificate to a value based
  63. on the B<op> argument. Currently B<op> can be B<SSL_CERT_SET_FIRST> to use
  64. the first valid certificate or B<SSL_CERT_SET_NEXT> to set the next valid
  65. certificate after the current certificate. These two operations can be
  66. used to iterate over all certificates in an B<SSL_CTX> structure.
  67. SSL_set_current_cert() also supports the option B<SSL_CERT_SET_SERVER>.
  68. If B<ssl> is a server and has sent a certificate to a connected client
  69. this option sets that certificate to the current certificate and returns 1.
  70. If the negotiated cipher suite is anonymous (and thus no certificate will
  71. be sent) 2 is returned and the current certificate is unchanged. If B<ssl>
  72. is not a server or a certificate has not been sent 0 is returned and
  73. the current certificate is unchanged.
  74. All these functions are implemented as macros. Those containing a B<1>
  75. increment the reference count of the supplied certificate or chain so it must
  76. be freed at some point after the operation. Those containing a B<0> do
  77. not increment reference counts and the supplied certificate or chain
  78. B<MUST NOT> be freed after the operation.
  79. =head1 NOTES
  80. The chains associate with an SSL_CTX structure are copied to any SSL
  81. structures when SSL_new() is called. SSL structures will not be affected
  82. by any chains subsequently changed in the parent SSL_CTX.
  83. One chain can be set for each key type supported by a server. So, for example,
  84. an RSA and a DSA certificate can (and often will) have different chains.
  85. The functions SSL_CTX_build_cert_chain() and SSL_build_cert_chain() can
  86. be used to check application configuration and to ensure any necessary
  87. subordinate CAs are sent in the correct order. Misconfigured applications
  88. sending incorrect certificate chains often cause problems with peers.
  89. For example an application can add any set of certificates using
  90. SSL_CTX_use_certificate_chain_file() then call SSL_CTX_build_cert_chain()
  91. with the option B<SSL_BUILD_CHAIN_FLAG_CHECK> to check and reorder them.
  92. Applications can issue non fatal warnings when checking chains by setting
  93. the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERRORS> and checking the return
  94. value.
  95. Calling SSL_CTX_build_cert_chain() or SSL_build_cert_chain() is more
  96. efficient than the automatic chain building as it is only performed once.
  97. Automatic chain building is performed on each new session.
  98. If any certificates are added using these functions no certificates added
  99. using SSL_CTX_add_extra_chain_cert() will be used.
  100. =head1 RETURN VALUES
  101. SSL_set_current_cert() with B<SSL_CERT_SET_SERVER> return 1 for success, 2 if
  102. no server certificate is used because the cipher suites is anonymous and 0
  103. for failure.
  104. SSL_CTX_build_cert_chain() and SSL_build_cert_chain() return 1 for success
  105. and 0 for failure. If the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> and
  106. a verification error occurs then 2 is returned.
  107. All other functions return 1 for success and 0 for failure.
  108. =head1 SEE ALSO
  109. L<ssl(7)>,
  110. L<SSL_CTX_add_extra_chain_cert(3)>
  111. =head1 HISTORY
  112. These functions were added in OpenSSL 1.0.2.
  113. =head1 COPYRIGHT
  114. Copyright 2013-2016 The OpenSSL Project Authors. All Rights Reserved.
  115. Licensed under the Apache License 2.0 (the "License"). You may not use
  116. this file except in compliance with the License. You can obtain a copy
  117. in the file LICENSE in the source distribution or at
  118. L<https://www.openssl.org/source/license.html>.
  119. =cut