Regenerate documentation.
This commit is contained in:
Christopher Kohlhoff
parent
7326ef932a
commit
7cbd3f65e1
@ -81000,6 +81000,13 @@ Protected destructor to prevent deletion through this type.
|
||||
|
||||
]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__context.impl_type [*impl_type]]]
|
||||
[(Deprecated: Use native_handle_type.) The native type of the SSL context. ]
|
||||
|
||||
]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__context.method [*method]]]
|
||||
@ -81055,6 +81062,11 @@ Protected destructor to prevent deletion through this type.
|
||||
Move-construct a context from another. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__context.impl [*impl]]]
|
||||
[(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__context.load_verify_file [*load_verify_file]]]
|
||||
[Load a certification authority file for performing verification. ]
|
||||
@ -81070,6 +81082,11 @@ Protected destructor to prevent deletion through this type.
|
||||
[Move-assign a context from another. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__context.set_default_verify_paths [*set_default_verify_paths]]]
|
||||
[Configures the context to use the default directories for finding certification authority certificates. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__context.set_options [*set_options]]]
|
||||
[Set options on the context. ]
|
||||
@ -81218,11 +81235,16 @@ This function is used to specify the name of a directory containing certificatio
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_load_verify_locations`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81250,11 +81272,16 @@ This function is used to specify the name of a directory containing certificatio
|
||||
|
||||
[[path][The name of a directory containing the certificates.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_load_verify_locations`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81404,6 +81431,43 @@ File format types.
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[section:impl ssl::context::impl]
|
||||
|
||||
[indexterm2 impl..ssl::context]
|
||||
(Deprecated: Use `native_handle()`.) Get the underlying implementation in the native type.
|
||||
|
||||
|
||||
impl_type impl();
|
||||
|
||||
|
||||
This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[section:impl_type ssl::context::impl_type]
|
||||
|
||||
[indexterm2 impl_type..ssl::context]
|
||||
(Deprecated: Use native\_handle\_type.) The native type of the SSL context.
|
||||
|
||||
|
||||
typedef SSL_CTX * impl_type;
|
||||
|
||||
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
[*Header: ][^asio/ssl/context.hpp]
|
||||
|
||||
[*Convenience header: ][^asio/ssl.hpp]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
@ -81451,11 +81515,16 @@ This function is used to load one or more trusted certification authorities from
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_load_verify_locations`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81483,11 +81552,16 @@ This function is used to load the certificates for one or more trusted certifica
|
||||
|
||||
[[filename][The name of a file containing certification authority certificates in PEM format.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_load_verify_locations`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81758,6 +81832,88 @@ Purpose of PEM password.
|
||||
[endsect]
|
||||
|
||||
|
||||
[section:set_default_verify_paths ssl::context::set_default_verify_paths]
|
||||
|
||||
[indexterm2 set_default_verify_paths..ssl::context]
|
||||
Configures the context to use the default directories for finding certification authority certificates.
|
||||
|
||||
|
||||
void ``[link asio.reference.ssl__context.set_default_verify_paths.overload1 set_default_verify_paths]``();
|
||||
`` [''''»''' [link asio.reference.ssl__context.set_default_verify_paths.overload1 more...]]``
|
||||
|
||||
asio::error_code ``[link asio.reference.ssl__context.set_default_verify_paths.overload2 set_default_verify_paths]``(
|
||||
asio::error_code & ec);
|
||||
`` [''''»''' [link asio.reference.ssl__context.set_default_verify_paths.overload2 more...]]``
|
||||
|
||||
|
||||
[section:overload1 ssl::context::set_default_verify_paths (1 of 2 overloads)]
|
||||
|
||||
|
||||
Configures the context to use the default directories for finding certification authority certificates.
|
||||
|
||||
|
||||
void set_default_verify_paths();
|
||||
|
||||
|
||||
This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
|
||||
|
||||
|
||||
[heading Exceptions]
|
||||
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_default_verify_paths`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[section:overload2 ssl::context::set_default_verify_paths (2 of 2 overloads)]
|
||||
|
||||
|
||||
Configures the context to use the default directories for finding certification authority certificates.
|
||||
|
||||
|
||||
asio::error_code set_default_verify_paths(
|
||||
asio::error_code & ec);
|
||||
|
||||
|
||||
This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
|
||||
|
||||
|
||||
[heading Parameters]
|
||||
|
||||
|
||||
[variablelist
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_default_verify_paths`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:set_options ssl::context::set_options]
|
||||
|
||||
[indexterm2 set_options..ssl::context]
|
||||
@ -81802,11 +81958,16 @@ This function may be used to configure the SSL options used by the context.
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_options`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81834,11 +81995,16 @@ This function may be used to configure the SSL options used by the context.
|
||||
|
||||
[[o][A bitmask of options. The available option values are defined in the [link asio.reference.ssl__context_base `ssl::context_base`] class. The options are bitwise-ored with any existing value for the options.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_options`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81903,11 +82069,16 @@ The return value of the callback is a string containing the password.]]
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_default_passwd_cb`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -81944,11 +82115,16 @@ This function is used to specify a callback function to obtain password informat
|
||||
``
|
||||
The return value of the callback is a string containing the password.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_default_passwd_cb`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82000,11 +82176,16 @@ This function may be used to configure the peer verification mode used by the co
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_verify`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82032,11 +82213,16 @@ This function may be used to configure the peer verification mode used by the co
|
||||
|
||||
[[v][A bitmask of peer verification modes. The available verify\_mode values are defined in the [link asio.reference.ssl__context_base `ssl::context_base`] class.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_verify`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82102,11 +82288,16 @@ This function is used to load a certificate chain into the context from a file.
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_certificate_chain_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82134,11 +82325,16 @@ This function is used to load a certificate chain into the context from a file.
|
||||
|
||||
[[filename][The name of the file containing the certificate. The file must use the PEM format.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_certificate_chain_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82195,11 +82391,16 @@ This function is used to load a certificate into the context from a file.
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_certificate_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82230,11 +82431,16 @@ This function is used to load a certificate into the context from a file.
|
||||
|
||||
[[format][The file format (ASN.1 or PEM).]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_certificate_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82291,11 +82497,16 @@ This function is used to load a private key into the context from a file.
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_PrivateKey_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82326,11 +82537,16 @@ This function is used to load a private key into the context from a file.
|
||||
|
||||
[[format][The file format (ASN.1 or PEM).]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_PrivateKey_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82387,11 +82603,16 @@ This function is used to load an RSA private key into the context from a file.
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_RSAPrivateKey_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82422,11 +82643,16 @@ This function is used to load an RSA private key into the context from a file.
|
||||
|
||||
[[format][The file format (ASN.1 or PEM).]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_use_RSAPrivateKey_file`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82478,11 +82704,16 @@ This function is used to load Diffie-Hellman parameters into the context from a
|
||||
|
||||
[variablelist
|
||||
|
||||
[[asio::system_error][Thrown on failure. ]]
|
||||
[[asio::system_error][Thrown on failure.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_tmp_dh`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -82510,11 +82741,16 @@ This function is used to load Diffie-Hellman parameters into the context from a
|
||||
|
||||
[[filename][The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.]]
|
||||
|
||||
[[ec][Set to indicate what error occurred, if any. ]]
|
||||
[[ec][Set to indicate what error occurred, if any.]]
|
||||
|
||||
]
|
||||
|
||||
|
||||
[heading Remarks]
|
||||
|
||||
Calls `SSL_CTX_set_tmp_dh`.
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -83092,6 +83328,13 @@ Provides stream-oriented functionality using SSL.
|
||||
[table
|
||||
[[Name][Description]]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__stream__impl_struct [*impl_struct]]]
|
||||
[Structure for use with deprecated impl_type. ]
|
||||
|
||||
]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__stream.handshake_type [*handshake_type]]]
|
||||
@ -83099,6 +83342,13 @@ Provides stream-oriented functionality using SSL.
|
||||
|
||||
]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__stream.impl_type [*impl_type]]]
|
||||
[(Deprecated: Use native_handle_type.) The underlying implementation type. ]
|
||||
|
||||
]
|
||||
|
||||
[
|
||||
|
||||
[[link asio.reference.ssl__stream.lowest_layer_type [*lowest_layer_type]]]
|
||||
@ -83156,6 +83406,11 @@ Provides stream-oriented functionality using SSL.
|
||||
[Perform SSL handshaking. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__stream.impl [*impl]]]
|
||||
[(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
|
||||
]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__stream.lowest_layer [*lowest_layer]]]
|
||||
[Get a reference to the lowest layer. ]
|
||||
@ -83539,6 +83794,43 @@ Different handshake types.
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[section:impl ssl::stream::impl]
|
||||
|
||||
[indexterm2 impl..ssl::stream]
|
||||
(Deprecated: Use `native_handle()`.) Get the underlying implementation in the native type.
|
||||
|
||||
|
||||
impl_type impl();
|
||||
|
||||
|
||||
This function may be used to obtain the underlying implementation of the context. This is intended to allow access to stream functionality that is not otherwise provided.
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[section:impl_type ssl::stream::impl_type]
|
||||
|
||||
[indexterm2 impl_type..ssl::stream]
|
||||
(Deprecated: Use native\_handle\_type.) The underlying implementation type.
|
||||
|
||||
|
||||
typedef impl_struct * impl_type;
|
||||
|
||||
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
[*Header: ][^asio/ssl/stream.hpp]
|
||||
|
||||
[*Convenience header: ][^asio/ssl.hpp]
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
@ -83633,7 +83925,27 @@ Get the underlying implementation in the native type.
|
||||
native_handle_type native_handle();
|
||||
|
||||
|
||||
This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
|
||||
This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
|
||||
|
||||
|
||||
[heading Example]
|
||||
|
||||
The `native_handle()` function returns a pointer of type `SSL*` that is suitable for passing to functions such as `SSL_get_verify_result` and `SSL_get_peer_certificate:`
|
||||
|
||||
asio::ssl::stream<asio:ip::tcp::socket> sock(io_service, ctx);
|
||||
|
||||
// ... establish connection and perform handshake ...
|
||||
|
||||
if (SSL_get_verify_result(sock.native_handle()) == X509_V_OK)
|
||||
{
|
||||
X509* cert = SSL_get_peer_certificate(sock.native_handle());
|
||||
// ...
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
@ -84094,6 +84406,47 @@ Destructor.
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:ssl__stream__impl_struct ssl::stream::impl_struct]
|
||||
|
||||
|
||||
Structure for use with deprecated impl\_type.
|
||||
|
||||
|
||||
struct impl_struct
|
||||
|
||||
|
||||
[heading Data Members]
|
||||
[table
|
||||
[[Name][Description]]
|
||||
|
||||
[
|
||||
[[link asio.reference.ssl__stream__impl_struct.ssl [*ssl]]]
|
||||
[]
|
||||
]
|
||||
|
||||
]
|
||||
|
||||
[heading Requirements]
|
||||
|
||||
[*Header: ][^asio/ssl/stream.hpp]
|
||||
|
||||
[*Convenience header: ][^asio/ssl.hpp]
|
||||
|
||||
|
||||
[section:ssl ssl::stream::impl_struct::ssl]
|
||||
|
||||
[indexterm2 ssl..ssl::stream::impl_struct]
|
||||
|
||||
SSL * ssl;
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
|
||||
|
||||
[endsect]
|
||||
|
||||
[section:ssl__stream_base ssl::stream_base]
|
||||
|
||||
Loading…
Reference in New Issue
Block a user