提交 c19b6c92 编写于 作者: R Richard Levitte

Clarifications and new documents.

Submitted by Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
上级 c5f8bbbc
=pod
=head1 NAME
SSL_CTX_set_ssl_version, SSL_set_ssl_method, SSL_get_ssl_method
- choose a new TLS/SSL method
=head1 SYNOPSIS
#include <openssl/ssl.h>
int SSL_CTX_set_ssl_version(SSL_CTX *ctx, SSL_METHOD *method);
int SSL_set_ssl_method(SSL *s, SSL_METHOD *method);
SSL_METHOD *SSL_get_ssl_method(SSL *ssl);
=head1 DESCRIPTION
SSL_CTX_set_ssl_version() sets a new default TLS/SSL B<method> for SSL objects
newly created from this B<ctx>. SSL objects already created with
L<SSL_new(3)|SSL_new(3)> are not affected, except when SSL_clear() is
being called.
SSL_set_ssl_method() sets a new TLS/SSL B<method> for a particular B<ssl>
object. It may be reset, when SSL_clear() is called.
SSL_get_ssl_method() returns a function pointer to the TLS/SSL method
set in B<ssl>.
=head1 NOTES
The available B<method> choices are described in
L<SSL_CTX_new(3)|SSL_CTX_new(3)>.
When SSL_clear() is called and no session is connected to an SSL object,
the method of the SSL object is reset to the method currently set in
the corresponding SSL_CTX object.
=head1 RETURN VALUES
The following return values can occur for SSL_CTX_set_ssl_version()
and SSL_set_ssl_method():
=over 4
=item 0
The new choice failed, check the error stack to find out the reason.
=item 1
The operation succeeded.
=back
=head1 SEE ALSO
L<SSL_CTX_new(3)|SSL_CTX_new(3)>, L<SSL_new(3)|SSL_new(3)>,
L<SSL_clear(3)|SSL_clear(3)>, L<ssl(3)|ssl(3)>
=cut
...@@ -14,8 +14,11 @@ SSL_accept - wait for a TLS/SSL client to initiate a TLS/SSL handshake ...@@ -14,8 +14,11 @@ SSL_accept - wait for a TLS/SSL client to initiate a TLS/SSL handshake
SSL_accept() waits for a TLS/SSL client to initiate the TLS/SSL handshake. SSL_accept() waits for a TLS/SSL client to initiate the TLS/SSL handshake.
The communication channel must already have been set and assigned to the The communication channel must already have been set and assigned to the
B<ssl> by setting an underlying B<BIO>. The behaviour of SSL_accept() depends B<ssl> by setting an underlying B<BIO>.
on the underlying BIO.
=head1 NOTES
The behaviour of SSL_accept() depends on the underlying BIO.
If the underlying BIO is B<blocking>, SSL_accept() will only return once the If the underlying BIO is B<blocking>, SSL_accept() will only return once the
handshake has been finished or an error occurred, except for SGC (Server handshake has been finished or an error occurred, except for SGC (Server
......
...@@ -14,8 +14,11 @@ SSL_connect - initiate the TLS/SSL handshake with an TLS/SSL server ...@@ -14,8 +14,11 @@ SSL_connect - initiate the TLS/SSL handshake with an TLS/SSL server
SSL_connect() initiates the TLS/SSL handshake with a server. The communication SSL_connect() initiates the TLS/SSL handshake with a server. The communication
channel must already have been set and assigned to the B<ssl> by setting an channel must already have been set and assigned to the B<ssl> by setting an
underlying B<BIO>. The behaviour of SSL_connect() depends on the underlying underlying B<BIO>.
BIO.
=head1 NOTES
The behaviour of SSL_connect() depends on the underlying BIO.
If the underlying BIO is B<blocking>, SSL_connect() will only return once the If the underlying BIO is B<blocking>, SSL_connect() will only return once the
handshake has been finished or an error occurred. handshake has been finished or an error occurred.
......
=pod
=head1 NAME
SSL_pending - obtain number of readable bytes buffered in an SSL object
=head1 SYNOPSIS
#include <openssl/ssl.h>
int SSL_pending(SSL *ssl);
=head1 DESCRIPTION
SSL_pending() returns the number of bytes which are available inside
B<ssl> for immediate read.
=head1 NOTES
Data are received in blocks from the peer. Therefore data can be buffered
inside B<ssl> and are ready for immediate retrieval with
L<SSL_read(3)|SSL_read(3)>.
=head1 RETURN VALUES
The number of bytes pending is returned.
L<SSL_read(3)|SSL_read(3)>, L<ssl(3)|ssl(3)>
=cut
...@@ -13,7 +13,11 @@ SSL_read - read bytes from a TLS/SSL connection. ...@@ -13,7 +13,11 @@ SSL_read - read bytes from a TLS/SSL connection.
=head1 DESCRIPTION =head1 DESCRIPTION
SSL_read() tries to read B<num> bytes from the specified B<ssl> into the SSL_read() tries to read B<num> bytes from the specified B<ssl> into the
buffer B<buf>. If necessary, SSL_read() will negotiate a TLS/SSL session, if buffer B<buf>.
=head1 NOTES
If necessary, SSL_read() will negotiate a TLS/SSL session, if
not already explicitly performed by SSL_connect() or SSL_accept(). If the not already explicitly performed by SSL_connect() or SSL_accept(). If the
peer requests a re-negotiation, it will be performed transparently during peer requests a re-negotiation, it will be performed transparently during
the SSL_read() operation. The behaviour of SSL_read() depends on the the SSL_read() operation. The behaviour of SSL_read() depends on the
...@@ -34,6 +38,12 @@ non-blocking socket, nothing is to be done, but select() can be used to check ...@@ -34,6 +38,12 @@ non-blocking socket, nothing is to be done, but select() can be used to check
for the required condition. When using a buffering BIO, like a BIO pair, data for the required condition. When using a buffering BIO, like a BIO pair, data
must be written into or retrieved out of the BIO before being able to continue. must be written into or retrieved out of the BIO before being able to continue.
=head1 IMPORTANT
When an SSL_read() operation has to be repeated because of
B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
with the same arguments.
=head1 RETURN VALUES =head1 RETURN VALUES
The following return values can occur: The following return values can occur:
......
...@@ -13,7 +13,11 @@ SSL_read - write bytes to a TLS/SSL connection. ...@@ -13,7 +13,11 @@ SSL_read - write bytes to a TLS/SSL connection.
=head1 DESCRIPTION =head1 DESCRIPTION
SSL_write() writes B<num> bytes from the buffer B<buf> into the specified SSL_write() writes B<num> bytes from the buffer B<buf> into the specified
B<ssl>. If necessary, SSL_write() will negotiate a TLS/SSL session, if B<ssl> connection.
=head1 NOTES
If necessary, SSL_write() will negotiate a TLS/SSL session, if
not already explicitly performed by SSL_connect() or SSL_accept(). If the not already explicitly performed by SSL_connect() or SSL_accept(). If the
peer requests a re-negotiation, it will be performed transparently during peer requests a re-negotiation, it will be performed transparently during
the SSL_write() operation. The behaviour of SSL_write() depends on the the SSL_write() operation. The behaviour of SSL_write() depends on the
...@@ -34,6 +38,12 @@ non-blocking socket, nothing is to be done, but select() can be used to check ...@@ -34,6 +38,12 @@ non-blocking socket, nothing is to be done, but select() can be used to check
for the required condition. When using a buffering BIO, like a BIO pair, data for the required condition. When using a buffering BIO, like a BIO pair, data
must be written into or retrieved out of the BIO before being able to continue. must be written into or retrieved out of the BIO before being able to continue.
=head1 IMPORTANT
When an SSL_write() operation has to be repeated because of
B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
with the same arguments.
=head1 RETURN VALUES =head1 RETURN VALUES
The following return values can occur: The following return values can occur:
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册