doc/ssl/SSL_CONF_CTX_set1_prefix.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CONF_CTX_set1_prefix - Set configuration context command prefix
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  unsigned int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *prefix);
  12
  13 =head1 DESCRIPTION
  14
  15 The function SSL_CONF_CTX_set1_prefix() sets the command prefix of B<cctx>
  16 to B<prefix>. If B<prefix> is B<NULL> it is restored to the default value.
  17
  18 =head1 NOTES
  19
  20 Command prefixes alter the commands recognised by subsequent SSL_CTX_cmd()
  21 calls. For example for files, if the prefix "SSL" is set then command names
  22 such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol"
  23 and "Options". Similarly for command lines if the prefix is "--ssl-" then
  24 "--ssl-no_tls1_2" is recognised instead of "-no_tls1_2".
  25
  26 If the B<SSL_CONF_FLAG_CMDLINE> flag is set then prefix checks are case
  27 sensitive and "-" is the default. In the unlikely even an application
  28 explicitly wants to set no prefix it must be explicitly set to "".
  29
  30 If the B<SSL_CONF_FLAG_FILE> flag is set then prefix checks are case
  31 insensitive and no prefix is the default.
  32
  33 =head1 RETURN VALUES
  34
  35 SSL_CONF_CTX_set1_prefix() returns 1 for success and 0 for failure.
  36
  37 =head1 SEE ALSO
  38
  39 L<SSL_CONF_CTX_new(3)|SSL_CONF_CTX_new(3)>,
  40 L<SSL_CONF_CTX_set_flags(3)|SSL_CONF_CTX_set_flags(3)>,
  41 L<SSL_CONF_CTX_set_ssl_ctx(3)|SSL_CONF_CTX_set_ssl_ctx(3)>,
  42 L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>,
  43 L<SSL_CONF_cmd_argv(3)|SSL_CONF_cmd_argv(3)>
  44
  45 =head1 HISTORY
  46
  47 These functions were first added to OpenSSL 1.0.2
  48
  49 =cut