doc/ssl/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 of 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_CERTIFICATE
  40
  41 recognise certificate and private key options.
  42
  43 =item SSL_CONF_FLAG_SHOW_ERRORS
  44
  45 indicate errors relating to unrecognised options or missing arguments in
  46 the error queue. If this option isn't set such errors are only reflected
  47 in the return values of SSL_CONF_set_cmd() or SSL_CONF_set_argv()
  48
  49 =back
  50
  51 =head1 RETURN VALUES
  52
  53 SSL_CONF_CTX_set_flags() and SSL_CONF_CTX_clear_flags() returns the new flags
  54 value after setting or clearing flags.
  55
  56 =head1 SEE ALSO
  57
  58 L<SSL_CONF_CTX_new(3)|SSL_CONF_CTX_new(3)>,
  59 L<SSL_CONF_CTX_set_ssl_ctx(3)|SSL_CONF_CTX_set_ssl_ctx(3)>,
  60 L<SSL_CONF_CTX_set1_prefix(3)|SSL_CONF_CTX_set1_prefix(3)>,
  61 L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>,
  62 L<SSL_CONF_cmd_argv(3)|SSL_CONF_cmd_argv(3)>
  63
  64 =head1 HISTORY
  65
  66 These functions were first added to OpenSSL 1.0.2
  67
  68 =cut