SSL_CONF_CTX_set1_prefix.pod 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. =pod
  2. =head1 NAME
  3. SSL_CONF_CTX_set1_prefix - Set configuration context command prefix
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. unsigned int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *prefix);
  7. =head1 DESCRIPTION
  8. The function SSL_CONF_CTX_set1_prefix() sets the command prefix of B<cctx>
  9. to B<prefix>. If B<prefix> is B<NULL> it is restored to the default value.
  10. =head1 NOTES
  11. Command prefixes alter the commands recognised by subsequent SSL_CONF_cmd()
  12. calls. For example for files, if the prefix "SSL" is set then command names
  13. such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol"
  14. and "Options". Similarly for command lines if the prefix is "--ssl-" then
  15. "--ssl-no_tls1_2" is recognised instead of "-no_tls1_2".
  16. If the B<SSL_CONF_FLAG_CMDLINE> flag is set then prefix checks are case
  17. sensitive and "-" is the default. In the unlikely even an application
  18. explicitly wants to set no prefix it must be explicitly set to "".
  19. If the B<SSL_CONF_FLAG_FILE> flag is set then prefix checks are case
  20. insensitive and no prefix is the default.
  21. =head1 RETURN VALUES
  22. SSL_CONF_CTX_set1_prefix() returns 1 for success and 0 for failure.
  23. =head1 SEE ALSO
  24. L<ssl(7)>,
  25. L<SSL_CONF_CTX_new(3)>,
  26. L<SSL_CONF_CTX_set_flags(3)>,
  27. L<SSL_CONF_CTX_set_ssl_ctx(3)>,
  28. L<SSL_CONF_cmd(3)>,
  29. L<SSL_CONF_cmd_argv(3)>
  30. =head1 HISTORY
  31. These functions were added in OpenSSL 1.0.2.
  32. =head1 COPYRIGHT
  33. Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
  34. Licensed under the Apache License 2.0 (the "License"). You may not use
  35. this file except in compliance with the License. You can obtain a copy
  36. in the file LICENSE in the source distribution or at
  37. L<https://www.openssl.org/source/license.html>.
  38. =cut