doc/man3/SSL_CONF_CTX_set_flags.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CONF_CTX_set_flags, SSL_CONF_CTX_clear_flags - Set or clear SSL configuration context flags
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
  12  unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
  13
  14 =head1 DESCRIPTION
  15
  16 The function SSL_CONF_CTX_set_flags() sets B<flags> in the context B<cctx>.
  17
  18 The function SSL_CONF_CTX_clear_flags() clears B<flags> in the context B<cctx>.
  19
  20 =head1 NOTES
  21
  22 The flags set affect how subsequent calls to SSL_CONF_cmd() or
  23 SSL_CONF_argv() behave.
  24
  25 Currently the following B<flags> values are recognised:
  26
  27 =over 4
  28
  29 =item SSL_CONF_FLAG_CMDLINE, SSL_CONF_FLAG_FILE
  30
  31 recognise options intended for command line or configuration file use. At
  32 least one of these flags must be set.
  33
  34 =item SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER
  35
  36 recognise options intended for use in SSL/TLS clients or servers. One or
  37 both of these flags must be set.
  38
  39 =item SSL_CONF_FLAG_CERTIFICATE
  40
  41 recognise certificate and private key options.
  42
  43 =item SSL_CONF_FLAG_REQUIRE_PRIVATE
  44
  45 If this option is set then if a private key is not specified for a certificate
  46 it will attempt to load a private key from the certificate file when
  47 SSL_CONF_CTX_finish() is called. If a key cannot be loaded from the certificate
  48 file an error occurs.
  49
  50 =item SSL_CONF_FLAG_SHOW_ERRORS
  51
  52 indicate errors relating to unrecognised options or missing arguments in
  53 the error queue. If this option isn't set such errors are only reflected
  54 in the return values of SSL_CONF_set_cmd() or SSL_CONF_set_argv()
  55
  56 =back
  57
  58 =head1 RETURN VALUES
  59
  60 SSL_CONF_CTX_set_flags() and SSL_CONF_CTX_clear_flags() returns the new flags
  61 value after setting or clearing flags.
  62
  63 =head1 SEE ALSO
  64
  65 L<SSL_CONF_CTX_new(3)>,
  66 L<SSL_CONF_CTX_set_ssl_ctx(3)>,
  67 L<SSL_CONF_CTX_set1_prefix(3)>,
  68 L<SSL_CONF_cmd(3)>,
  69 L<SSL_CONF_cmd_argv(3)>
  70
  71 =head1 HISTORY
  72
  73 These functions were added in OpenSSL 1.0.2.
  74
  75 =head1 COPYRIGHT
  76
  77 Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
  78
  79 Licensed under the Apache License 2.0 (the "License").  You may not use
  80 this file except in compliance with the License.  You can obtain a copy
  81 in the file LICENSE in the source distribution or at
  82 L<https://www.openssl.org/source/license.html>.
  83
  84 =cut