root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/SSL_CONF_CTX_set_flags.pod

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

86 lines
2.3 KiB
Plaintext
Raw Normal View History

add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
=pod
=head1 NAME
Typo in SSL_CONF_CTX_set_flags.pod Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3070)
2017-03-28 14:25:52 +08:00
SSL_CONF_CTX_set_flags, SSL_CONF_CTX_clear_flags - Set or clear SSL configuration context flags
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
=head1 DESCRIPTION
The function SSL_CONF_CTX_set_flags() sets B<flags> in the context B<cctx>.
The function SSL_CONF_CTX_clear_flags() clears B<flags> in the context B<cctx>.
=head1 NOTES
fix typos in SSL_CONF documentation
2012-11-17 08:21:34 +08:00
The flags set affect how subsequent calls to SSL_CONF_cmd() or
SSL_CONF_argv() behave.
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
Currently the following B<flags> values are recognised:
=over 4
documentation fixes
2012-12-07 07:26:11 +08:00
=item SSL_CONF_FLAG_CMDLINE, SSL_CONF_FLAG_FILE
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
recognise options intended for command line or configuration file use. At
least one of these flags must be set.
=item SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER
recognise options intended for use in SSL/TLS clients or servers. One or
both of these flags must be set.
typo Reviewed-by: Kurt Roeckx <kurt@openssl.org>
2015-02-22 21:13:12 +08:00
=item SSL_CONF_FLAG_CERTIFICATE
Extend SSL_CONF Extend SSL_CONF to return command value types. Add certificate and key options. Update documentation.
2013-10-18 23:09:12 +08:00
recognise certificate and private key options.
Support key loading from certificate file Support loading of key and certificate from the same file if SSL_CONF_FLAG_REQUIRE_PRIVATE is set. This is done by remembering the filename used for each certificate type and attempting to load a private key from the file when SSL_CONF_CTX_finish is called. Update docs. Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-02-16 21:44:22 +08:00
=item SSL_CONF_FLAG_REQUIRE_PRIVATE
If this option is set then if a private key is not specified for a certificate
it will attempt to load a private key from the certificate file when
SSL_CONF_CTX_finish() is called. If a key cannot be loaded from the certificate
file an error occurs.
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
=item SSL_CONF_FLAG_SHOW_ERRORS
indicate errors relating to unrecognised options or missing arguments in
the error queue. If this option isn't set such errors are only reflected
in the return values of SSL_CONF_set_cmd() or SSL_CONF_set_argv()
fix typos in SSL_CONF documentation
2012-11-17 08:21:34 +08:00
=back
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
=head1 RETURN VALUES
SSL_CONF_CTX_set_flags() and SSL_CONF_CTX_clear_flags() returns the new flags
value after setting or clearing flags.
=head1 SEE ALSO
Add L<ssl(7)> to all SSL pages Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10208)
2019-11-02 00:27:29 +08:00
L<ssl(7)>,
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-18 03:21:33 +08:00
L<SSL_CONF_CTX_new(3)>,
L<SSL_CONF_CTX_set_ssl_ctx(3)>,
L<SSL_CONF_CTX_set1_prefix(3)>,
L<SSL_CONF_cmd(3)>,
L<SSL_CONF_cmd_argv(3)>
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
=head1 HISTORY
man: harmonize the various formulations in the HISTORY sections While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
2018-12-09 08:02:36 +08:00
These functions were added in OpenSSL 1.0.2.
add SSL_CONF functions and documentation
2012-11-17 03:12:24 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut